The NetworkComms type exposes the following members.
Back to Top
Methods
| Name | Description | |
|---|---|---|
  | AllConnectionInfo(Boolean) |
Returns a ConnectionInfo array containing information for all connections
|
| AllConnectionInfo(ShortGuid, Boolean) |
Returns a ConnectionInfo array containing information for all connections which have the provided networkIdentifier.
It is also possible to include information for closed connections.
|
| AppendGlobalConnectionCloseHandler |
Add a new connection shutdown delegate which will be called for every connection as it is closes.
|
| AppendGlobalConnectionEstablishHandler |
Add a new connection establish delegate which will be called for every connection once it has been successfully established.
|
| AppendGlobalIncomingPacketHandler incomingObjectType (String, NetworkComms PacketHandlerCallBackDelegate incomingObjectType ) |
Add an incoming packet handler using default SendReceiveOptions. Multiple handlers for the same packet type will be
executed in the order they are added.
|
| AppendGlobalIncomingPacketHandler incomingObjectType (String, NetworkComms PacketHandlerCallBackDelegate incomingObjectType , SendReceiveOptions) |
Add an incoming packet handler using the provided SendReceiveOptions. Multiple handlers for the same packet type will be executed in the order they are added.
|
| AppendGlobalIncomingUnmanagedPacketHandler |
Add an incoming packet handler for unmanaged packets. Multiple handlers will be executed in the order they are added.
|
| CloseAllConnections |
Close all connections
|
| CloseAllConnections(ConnectionType) |
Close all connections of the provided ConnectionType |
| CloseAllConnections(ConnectionType, EndPoint ) | |
| ConnectionExists(ConnectionInfo) |
Check if a connection with the provided ConnectionInfo exists. Internally matches connection based on IPEndPoint, ConnectionType,
NetworkIdentifier and ApplicationLayerProtocol status.
|
| ConnectionExists(ShortGuid, ConnectionType, ApplicationLayerProtocolStatus) |
Check if a connection exists with the provided parameters.
|
| ConnectionExists(EndPoint, EndPoint, ConnectionType, ApplicationLayerProtocolStatus) |
Check if a connection exists with the provided parameters.
|
| DisableLogging |
Disable all logging in NetworkCommsDotNet
|
| EnableLogging |
Enable logging using a default config. All log output is written directly to the local console.
|
| EnableLogging(ILogger) |
Enable logging using the provided config. See examples for usage.
|
| GetExistingConnection(ApplicationLayerProtocolStatus) |
Returns a list of all connections which match the provided parameters. If no parameter are provided returns all connections.
|
| GetExistingConnection(ConnectionInfo) |
Retrieve an existing connection with the provided ConnectionInfo. Internally matches connection based on IPEndPoint, ConnectionType,
NetworkIdentifier and ApplicationLayerProtocol status.
|
| GetExistingConnection(ConnectionType, ApplicationLayerProtocolStatus) |
Returns a list of all connections matching the provided parameters.
|
| GetExistingConnection(ShortGuid, ConnectionType, ApplicationLayerProtocolStatus) |
Returns a list of all connections matching the provided parameters.
|
| GetExistingConnection(EndPoint, EndPoint, ConnectionType, ApplicationLayerProtocolStatus) |
Returns a list of all connections matching the provided parameters.
|
| GlobalIncomingPacketHandlerExists(String) |
Returns true if a global packet handler exists for the provided packet type.
|
| GlobalIncomingPacketHandlerExists packetHandlerIncomingObjectType (String, NetworkComms PacketHandlerCallBackDelegate packetHandlerIncomingObjectType ) |
Returns true if the provided global packet handler has been added for the provided packet type.
|
| GlobalIncomingUnmanagedPacketHandlerExists |
Returns true if a global unmanaged packet handler exists
|
| GlobalIncomingUnmanagedPacketHandlerExists packetHandlerIncomingObjectType (NetworkComms PacketHandlerCallBackDelegate packetHandlerIncomingObjectType ) |
Returns true if the provided global unmanaged packet handler has been added.
|
| GlobalPacketTypeUnwrapperOptions |
Returns the unwrapper SendReceiveOptions for the provided packet type. If no specific options are registered returns null.
|
| RemoveGlobalConnectionCloseHandler |
Remove a connection shutdown delegate.
|
| RemoveGlobalConnectionEstablishHandler |
Remove a connection establish delegate.
|
| RemoveGlobalIncomingPacketHandler |
Removes all delegates for all packet types
|
| RemoveGlobalIncomingPacketHandler(String) |
Removes all delegates for the provided packet type.
|
| RemoveGlobalIncomingPacketHandler packetHandlerIncomingObjectType (String, NetworkComms PacketHandlerCallBackDelegate packetHandlerIncomingObjectType ) |
Removes the provided delegate for the specified packet type. If the provided delegate does not exist for this packet type just returns.
|
| RemoveGlobalIncomingUnmanagedPacketHandler |
Removes all unmanaged packet handlers.
|
| RemoveGlobalIncomingUnmanagedPacketHandler packetHandlerIncomingObjectType (NetworkComms PacketHandlerCallBackDelegate packetHandlerIncomingObjectType ) |
Removes the provided delegate for unmanaged packet types. If the provided delegate does not exist for this packet type just returns.
|
| SendObject sendObjectType |
Send the provided object to the specified destination using TCP. Uses default sendReceiveOptions. For more control over
options see connection specific methods.
|
| SendReceiveObject sendObjectType, returnObjectType |
Send the provided object to the specified destination and wait for a return object using TCP. Uses default sendReceiveOptions.
For more control over options see connection specific methods.
|
| Shutdown |
Shutdown all connections, threads and execute OnCommsShutdown event. Any packet handlers are left unchanged. If any network
activity has taken place this should be called on application close.
|
| TotalNumConnections |
Returns the total number of connections
|
| TotalNumConnections(IPAddress) | |
| TriggerGlobalPacketHandlers(PacketHeader, Connection, MemoryStream, SendReceiveOptions) |
Trigger incoming packet delegates for the provided parameters.
|
| TriggerGlobalPacketHandlers(PacketHeader, Connection, MemoryStream, SendReceiveOptions, Boolean) |
Trigger incoming packet delegates for the provided parameters.
|
See Also