ProtocolSocket Class |
A connection to a peer (either a client or a server connection), or a protocol server.
Inheritance HierarchySystemObject
Demo3D.NetProtocolSocket
Demo3D.NetConnection
Demo3D.NetProtocolHead
Demo3D.NetProtocolInstance
Demo3D.NetProtocolSocket
Demo3D.NetConnection
Demo3D.NetProtocolHead
Demo3D.NetProtocolInstance
Namespace: Demo3D.Net
Assembly: Demo3D.IO (in Demo3D.IO.dll) Version: 18.03.00
SyntaxC#
[TypeConverterAttribute(typeof(ExpandableObjectConverter))] public abstract class ProtocolSocket : IBatchEditable, IServiceProvider, INotifyPropertyChanged
The ProtocolSocket type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ProtocolSocket |
Constructs a ProtocolSocket.
|
Properties| Name | Description | |
|---|---|---|
 | Address |
The address used to create this socket.
|
| DownStream |
The downstream socket.
|
| ID |
A description of this socket.
|
| Log |
Log messages.
|
 | Properties |
Protocol and service properties.
|
| Running |
Returns whether the socket is still running.
|
Methods| Name | Description | |
|---|---|---|
 | AddAspect |
Adds an aspect to a socket.
|
| AddOrUpdateAspect |
Adds or updates an aspect of the socket.
|
| BeginEditAsync |
Start batch editing.
|
| EndEditAsync |
End batch editing.
|
| FindAspect(Type) |
Returns an aspect of the given type, or return null.
|
| FindAspectT |
Returns an aspect of the given type, or return null.
|
| FindService(Type, ServiceBindingFlags, String) |
Returns an object that implements a specific API, or null.
For example, an IO API such as IPacketIOService.
|
| FindServiceT(ServiceBindingFlags, String) |
Returns an object that implements a specific API, or null.
For example, an IO API such as IPacketIOService.
|
| GetDownStream |
Returns the downstream socket.
|
| GetHead |
Returns the protocol head.
|
| GetOrAddAspect |
Adds an aspect to a socket by using the specified function, if the key does not already exist.
|
| GetServiceT |
Returns an object that implements a specific API, or throws an exception.
For example, an IO API such as IPacketIOService.
|
| GetStream |
Returns the head of the protocol stream (the first protocol instance).
|
| InitializeAsync |
When overridden in a derived class, initializes the socket.
|
| NotifyEditBegunAsync |
Notify EditBegunAsync raised.
|
| NotifyEditEndedAsync |
Notify EditEndedAsync raised.
|
| NotifyPropertyChanged(PropertyChangedEventArgs) |
Raises the PropertyChanged event.
|
| NotifyPropertyChanged(String) |
Raises the PropertyChanged event.
|
| OpenAsync |
Opens (or reopens) the socket.
|
| RegisterClosing |
Registers a function to call when Close has been called but before the socket has been closed.
|
| RegisterOpen |
Registers a function to call after the socket is opened, but before the OnOpenedAsync event is fired.
|
| RemoveAspect |
Removes an aspect from a socket.
|
| SetDownStream |
Sets the downstream socket.
|
| SetLog |
Sets the current log.
|
| Shutdown(Boolean) |
Forcibly shuts down the socket, without logging an error.
|
| Shutdown(Exception) |
Forcibly shuts down the socket, and then logs an error.
|
| Shutdown(String, Boolean) |
Forcibly shuts down the socket, and then logs an error.
|
| Shutdown(LogMessageLogLevel, String, Object) |
Forcibly shuts down the socket, and then logs an error.
|
| ShutdownAsync(Boolean, Boolean) |
Forcibly shuts down the socket, without logging an error.
|
| ShutdownAsync(Boolean, Exception) |
Forcibly shuts down the socket, and then logs an error.
|
| ShutdownAsync(Boolean, String, Boolean) |
Forcibly shuts down the socket, and then logs an error.
|
| ShutdownAsync(Boolean, LogMessageLogLevel, String, Object) |
Forcibly shuts down the socket, and then logs an error.
|
| ToString |
Returns a description of this socket.
(Overrides ObjectToString.) |
| UnregisterClosing |
Unregister a previously registered function.
|
| UnregisterOpen |
Unregister a previously registered function.
|
Events| Name | Description | |
|---|---|---|
 | EditBegunAsync |
Raised on the first call to BeginEdit.
|
| EditEndedAsync |
Raised on the last call to EndEdit.
|
| OnClosedAsync |
Occurs after the socket is closed.
|
| 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).
|
| OnOpenedAsync |
Occurs after the socket is opened.
|
| OnShutdownAsync |
Occurs after the socket is shutdown.
|
| PropertyChanged |
Occurs when a property value changes.
|
See Also