Connection Class |
A client connection to a peer.
Inheritance HierarchyNamespace: Demo3D.Net
Assembly: Demo3D.IO (in Demo3D.IO.dll) Version: 19.00.00
SyntaxC#
public class Connection : ProtocolSocket
The Connection type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Address |
The address used to create this socket.
(Inherited from ProtocolSocket) |
| DownStream |
The downstream socket.
(Inherited from ProtocolSocket) |
| ID |
A description of this socket.
(Inherited from ProtocolSocket) |
| Log |
Log messages.
(Inherited from ProtocolSocket) |
| LogShutdownMessages | Controls whether shutdown messages should be logged to the message log. |
 | Properties |
Protocol and service properties.
(Inherited from ProtocolSocket) |
 | Registry | A register of all open sockets. |
| Running |
Returns whether the socket is still running.
(Overrides ProtocolSocketRunning) |
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) |
| CloseAsync |
Closes the socket.
(Overrides ProtocolSocket.CloseAsync(Boolean, Object)) |
| 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) |
| Link | Adds a 'link' reference. |
| NotifyPropertyChanged(PropertyChangedEventArgs) |
Raises the PropertyChanged event.
(Inherited from ProtocolSocket) |
| NotifyPropertyChanged(String) |
Raises the PropertyChanged event.
(Inherited from ProtocolSocket) |
| Open(OpenParams) | Opens a socket. |
| Open(OpenFlags, Object) | Opens (or reopens) the socket. |
| Open(ProtocolAddress, Flags, Object) | Opens a socket. |
| Open(ProtocolAddress, IEnumerableType, Flags, Object) | Opens a socket. |
| Open(ProtocolAddress, Type, Flags, Object) | Opens a socket. |
| OpenAsync(Boolean, OpenParams) | Opens a socket. |
| OpenAsync(Boolean, Flags, Object) |
Opens the socket.
(Overrides ProtocolSocketOpenAsync(Boolean, Flags, Object)) |
| OpenAsync(Boolean, OpenFlags, Object) | Opens the socket. |
| OpenAsync(Boolean, ProtocolAddress, Flags, Object) | Opens a socket. |
| OpenAsync(Boolean, ProtocolAddress, IEnumerableType, Flags, Object) | Opens a socket. |
| OpenAsync(Boolean, ProtocolAddress, Type, Flags, Object) | Opens a socket. |
| 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.
(Inherited from ProtocolSocket) |
| Shutdown(Boolean) |
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, Boolean) |
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) |
| ShutdownAsync(Boolean, Boolean) |
Forcibly shuts down the socket, without logging an error.
(Inherited from ProtocolSocket) |
| ShutdownAsync(Boolean, Exception) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket) |
| ShutdownAsync(Boolean, String, Boolean) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket) |
| ShutdownAsync(Boolean, LogMessageLogLevel, String, Object) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket) |
| ToString |
Returns a description of this socket.
(Inherited from ProtocolSocket) |
| Unlink | Remove a 'link' reference count. |
| UnlinkRequest | Raises the OnUnlinkRequest event. |
| UnregisterClosing |
Unregister a previously registered function.
(Inherited from ProtocolSocket) |
| UnregisterOpen |
Unregister a previously registered function.
(Inherited from ProtocolSocket) |
Events| Name | Description | |
|---|---|---|
 | OnClosedAsync |
Occurs after the socket is closed.
(Inherited from ProtocolSocket) |
| OnConnectionAdded | Occurs when a connection is added to the registry. |
| OnConnectionRemoved | Occurs when a connection is removed from the registry. |
| OnConnectionStateChanged | Occurs when a connection state changes. |
| 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, Object).
(Inherited from ProtocolSocket) |
| OnLinked | Occurs when a link is made to this socket. |
| OnOpenedAsync |
Occurs after the socket is opened.
(Inherited from ProtocolSocket) |
| OnShutdownAsync |
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. |
| PropertyChanged |
Occurs when a property value changes.
(Inherited from ProtocolSocket) |
See Also