ProtocolHead Class |
The head of the protocol stream.
Inheritance HierarchyNamespace: Demo3D.Net
Assembly: Demo3D.IO (in Demo3D.IO.dll) Version: 15.0.2.11458
SyntaxC#
public class ProtocolHead : ProtocolSocket
The ProtocolHead type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Address |
The address used to create this socket.
(Overrides ProtocolSocketAddress.) |
| DownStream |
The downstream socket.
(Inherited from ProtocolSocket.) |
| ID |
A description of this socket.
(Inherited from ProtocolSocket.) |
| Log |
Log messages.
(Overrides ProtocolSocketLog.) |
| Properties |
Protocol and service properties.
(Overrides ProtocolSocketProperties.) |
| Running |
Returns whether the instance is still running.
(Overrides ProtocolSocketRunning.) |
| SocketFlags |
Socket flags. (Flags are OR'ed together each time the protocol is built.)
|
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.) |
| BeginEditAsync |
Start batch editing.
(Inherited from ProtocolSocket.) |
| Close |
Closes the socket.
(Overrides ProtocolSocket.Close.) |
| EndEditAsync |
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, String) |
Returns an object that implements a specific API, or null.
For example, an IO API such as IPacketIOService.
(Inherited from ProtocolSocket.) |
| FindServiceT(ServiceBindingFlags, String) |
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.) |
| NotifyEditBegunAsync |
Notify EditBegunAsync raised.
(Inherited from ProtocolSocket.) |
| NotifyEditEndedAsync |
Notify EditEndedAsync raised.
(Inherited from ProtocolSocket.) |
| NotifyPropertyChanged(PropertyChangedEventArgs) |
Raises the PropertyChanged event.
(Inherited from ProtocolSocket.) |
| NotifyPropertyChanged(String) |
Raises the PropertyChanged event.
(Inherited from ProtocolSocket.) |
| OpenAsync |
Opens (or reopen) the socket.
(Overrides ProtocolSocketOpenAsync(Boolean, Flags).) |
| 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 OnOpenedAsync event is fired.
(Inherited from ProtocolSocket.) |
| RemoveAspect |
Removes an aspect from a socket.
(Inherited from ProtocolSocket.) |
| SetDownStream |
Sets the downstream socket.
(Inherited from ProtocolSocket.) |
| SetLog |
Sets the current log.
(Overrides ProtocolSocketSetLog(IComponentLogger).) |
| Shutdown |
Forcibly shuts down the socket, without logging an error.
(Inherited from ProtocolSocket.) |
| Shutdown(Exception) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket.) |
| Shutdown(String) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket.) |
| Shutdown(LogMessageLogLevel, String, Object) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket.) |
| TakeStream |
Returns the head of the protocol stream (the first protocol instance), and also
removes the stream from the ProtocolHead. The stream can then be re-assigned to a
different ProtocolHead.
|
| ToString |
Returns a description of this socket.
(Inherited from ProtocolSocket.) |
| UnregisterClosing |
Unregister a previously registered function.
(Inherited from ProtocolSocket.) |
| UnregisterOpen |
Unregister a previously registered function.
(Inherited from ProtocolSocket.) |
Events| Name | Description | |
|---|---|---|
 | EditBegunAsync |
Raised on the first call to BeginEdit.
(Inherited from ProtocolSocket.) |
| EditEndedAsync |
Raised on the last call to EndEdit.
(Inherited from ProtocolSocket.) |
| OnClosed |
Occurs after the socket is closed.
(Inherited from ProtocolSocket.) |
| OnDisposed |
Occurs when the socket is disposed.
A socket is disposed when it's closed and uncached from the connection registry.
User script may retain a reference, and may resurrect the socket by calling OpenAsync(Boolean, OpenFlags).
(Inherited from ProtocolSocket.) |
| OnLinked |
Occurs when a link is made to this socket.
|
| OnOpenedAsync |
Occurs after the socket is opened.
(Inherited from ProtocolSocket.) |
| OnShutdown |
Occurs after the socket is shutdown.
(Inherited from ProtocolSocket.) |
| OnUnlinked |
Occurs when a link is removed from this socket.
|
| OnUnlinkRequest |
Occurs when an object is requested to unlink from this socket.
|
| OnUpstreamLinked |
Occurs when a new upstream socket links to this protocol head.
|
| OnUpstreamUnlinked |
Occurs when a new upstream socket unlinks from this protocol head.
|
| PropertyChanged |
Occurs when a property value changes.
(Inherited from ProtocolSocket.) |
See Also