ProtocolInstance Class

This is one instance of a protocol connection (either a client or a server connection), or a protocol server. This class represents one link in the overall protocol stream. Created by Protocol, it manages the protocol for just this link in the stream. Uses the services of, and provides services to, its downstream and upstream instances.

Inheritance Hierarchy

SystemObject
Demo3D.NetProtocolSocket
Demo3D.NetProtocolInstance

Namespace: Demo3D.Net
Assembly: Demo3D.IO (in Demo3D.IO.dll) Version: 10.0.0.0 (10.0.0.0)

Syntax

Copy

public abstract class ProtocolInstance : ProtocolSocket

The ProtocolInstance type exposes the following members.

Constructors

	Name	Description
	ProtocolInstance	Constructs a new ProtocolInstance.

Top

Properties

	Name	Description
	Address	The protocol address used by this instance. (Overrides ProtocolSocketAddress.)
	DownStream	The downstream socket. (Inherited from ProtocolSocket.)
	Editing	True if batch editing. (Inherited from ProtocolSocket.)
	ID	A description of this instance. (Overrides ProtocolSocketID.)
	InternalRunning	Indicates whether the instance is still running.
	Properties	Protocol and service properties. (Overrides ProtocolSocketProperties.)
	Protocol	The protocol.
	ProtocolProperties	Protocol property bag.
	Running	Returns whether the instance is still running. (Overrides ProtocolSocketRunning.)

Top

Methods

	Name	Description
	AddAspect	Adds an aspect to a socket. (Inherited from ProtocolSocket.)
	AddOrUpdateAspect	Adds or updates an aspect of the socket. (Inherited from ProtocolSocket.)
	BeginEdit	Start batch editing. (Inherited from ProtocolSocket.)
	Close	Closes the socket. (Overrides ProtocolSocketClose.)
	Close(Exception)	Logs an error, and then closes the socket. (Inherited from ProtocolSocket.)
	Close(String)	Logs an error, and then closes the socket. (Inherited from ProtocolSocket.)
	Close(String, String, Object)	Logs an error, and then closes the socket. (Inherited from ProtocolSocket.)
	EndEdit	End batch editing. (Inherited from ProtocolSocket.)
	FindAspect(Type)	Returns an aspect of the given type, or return null. (Inherited from ProtocolSocket.)
	FindAspectT	Returns an aspect of the given type, or return null. (Inherited from ProtocolSocket.)
	FindService(Type, ServiceBindingFlags)	Returns an object that implements a specific API, or null. For example, an IO API such as IPacketIOService. (Overrides ProtocolSocketFindService(Type, ServiceBindingFlags).)
	FindServiceT(ServiceBindingFlags)	Returns an object that implements a specific API, or null. For example, an IO API such as IPacketIOService. (Inherited from ProtocolSocket.)
	GetDownStream	Returns the downstream socket. (Inherited from ProtocolSocket.)
	GetHead	Returns the protocol head. (Overrides ProtocolSocketGetHead.)
	GetOrAddAspect	Adds an aspect to a socket by using the specified function, if the key does not already exist. (Inherited from ProtocolSocket.)
	GetServiceT	Returns an object that implements a specific API, or throws an exception. For example, an IO API such as IPacketIOService. (Inherited from ProtocolSocket.)
	GetStream	Returns the head of the protocol stream (the first protocol instance). (Inherited from ProtocolSocket.)
	InitializeAsync	When overridden in a derived class, initializes the socket. (Inherited from ProtocolSocket.)
	InternalClose	Performs a controlled close.
	InternalOpenAsync	Opens or reopens the instance.
	InternalShutdown	Forcibly shuts down the underlying protocol, causing all other users to throw an error.
	NotifyPropertyChanged(PropertyChangedEventArgs)	Raises the PropertyChanged event. (Inherited from ProtocolSocket.)
	NotifyPropertyChanged(String)	Raises the PropertyChanged event. (Inherited from ProtocolSocket.)
	Open	Opens (or reopens) the socket. (Inherited from ProtocolSocket.)
	OpenAsync	Opens (or reopens) the socket. (Overrides ProtocolSocketOpenAsync.)
	RegisterClosing	Registers a function to call when Close has been called but before the socket has been closed. (Inherited from ProtocolSocket.)
	RegisterOpen	Registers a function to call after the socket is opened, but before the OnOpened event is fired. (Inherited from ProtocolSocket.)
	RemoveAspect	Removes an aspect from a socket. (Inherited from ProtocolSocket.)
	SetDownStream	Sets the downstream socket. (Overrides ProtocolSocketSetDownStream(ProtocolSocket).)
	Shutdown	Forcibly shuts down the socket. (Overrides ProtocolSocketShutdown.)
	Shutdown(Exception)	Logs an error, and then shuts down the socket. (Inherited from ProtocolSocket.)
	Shutdown(String)	Logs an error, and then shuts down the socket. (Inherited from ProtocolSocket.)
	Shutdown(String, String, Object)	Logs an error, and then shuts down the socket. (Overrides ProtocolSocketShutdown(String, String, Object).)
	ToString	Returns a description of this socket. (Overrides ProtocolSocketToString.)
	TryCreateService	Returns an object that implements a specific API, or null. For example, an IO API such as IPacketIOService.
	TryFindServiceT	Searches for an object that implements a specific API, or null. Only searches on this ProtocolInstance, and does not create the service if it hasn't already been created. (Inherited from ProtocolSocket.)
	UnregisterClosing	Unregister a previously registered function. (Inherited from ProtocolSocket.)
	UnregisterOpen	Unregister a previously registered function. (Inherited from ProtocolSocket.)

Top

Events

	Name	Description
	EditBegun	Raised on the first call to BeginEdit. (Inherited from ProtocolSocket.)
	EditEnded	Raised on the last call to EndEdit. (Inherited from ProtocolSocket.)
	OnClosed	Occurs after the socket is closed. (Inherited from ProtocolSocket.)
	OnOpened	Occurs after the socket is opened. (Inherited from ProtocolSocket.)
	OnShutdown	Occurs after the socket is shutdown. (Inherited from ProtocolSocket.)
	PropertyChanged	Occurs when a property value changes. (Inherited from ProtocolSocket.)

Top

Reference

Demo3D.Net Namespace