Base library providing methods to track connections, global configurations, send and receive objects.
Classes
Class | Description | |
---|---|---|
CheckSumException |
A checksum error has occurred. NetworkComms.EnablePacketCheckSumValidation must be set to true for this exception to be thrown.
| |
CommsException |
Base exception. All connection related exceptions can be caught in a single catch block by using catch(CommsException)
| |
CommsSetupShutdownException |
An error occurred while trying to setup or shutdown NetworkComms.Net
| |
CommunicationException |
An error occurred while during communication which does not fall under other exception cases.
| |
ConfirmationTimeoutException |
A timeout has occurred while waiting for a confirmation packet to be received. Check for errors and or consider increasing NetworkComms.PacketConfirmationTimeoutMS
| |
ConnectionInfo |
Contains any information related to the configuration of a Connection object.
| |
ConnectionSendTimeoutException |
A connection send has timed out.
| |
ConnectionSetupException |
An error occurred while trying to establish a Connection
| |
ConnectionShutdownException |
An error occurred while trying to establish a Connection
| |
DuplicateConnectionException |
A possible duplicate connection has been detected.
| |
ExpectedReturnTimeoutException |
A timeout has occurred while waiting for an expected return object. Check for errors and or consider increasing the provided return timeout value.
| |
InvalidNetworkIdentifierException |
An invalid network identifier has been provided.
| |
NetworkComms |
Top level interface for NetworkComms.Net library. Anything which is not connection specific generally happens
within the NetworkComms class. e.g. Keeping track of all connections, global defaults and settings, serialisers
and data processors etc.
| |
Packet |
Wrapper for PacketHeader and packetData.
| |
PacketHandlerException |
An error occurred during a packetType data handler execution.
| |
PacketHeader |
Contains information required to send, receive and correctly rebuild any objects sent via NetworkComms.Net.
Any data sent via NetworkCommsDotNet is always preceded by a packetHeader.
| |
SendReceiveOptions |
Contains options and flags for sending and receiving data such as serialisation method, data processors, encryption etc.
Several static constructors are provided to help create SendReceiveOptions in the most common formats.
| |
SendReceiveOptions T_DS |
Contains options and flags for sending and receiving data such as serialisation method, data processors, encryption etc.
Several static constructors are provided to help create SendReceiveOptions in the most common formats.
| |
SendReceiveOptions T_DS, T_DP1 |
Contains options and flags for sending and receiving data such as serialisation method, data processors, encryption etc.
Several static constructors are provided to help create SendReceiveOptions in the most common formats.
| |
SendReceiveOptions T_DS, T_DP1, T_DP2 |
Contains options and flags for sending and receiving data such as serialisation method, data processors, encryption etc.
Several static constructors are provided to help create SendReceiveOptions in the most common formats.
| |
SendReceiveOptions T_DS, T_DP1, T_DP2, T_DP3 |
Contains options and flags for sending and receiving data such as serialisation method, data processors, encryption etc.
Several static constructors are provided to help create SendReceiveOptions in the most common formats.
| |
SendReceiveOptions T_DS, T_DP1, T_DP2, T_DP3, T_DP4 |
Contains options and flags for sending and receiving data such as serialisation method, data processors, encryption etc.
Several static constructors are provided to help create SendReceiveOptions in the most common formats.
| |
SendReceiveOptions T_DS, T_DP1, T_DP2, T_DP3, T_DP4, T_DP5 |
Contains options and flags for sending and receiving data such as serialisation method, data processors, encryption etc.
Several static constructors are provided to help create SendReceiveOptions in the most common formats.
| |
SendReceiveOptions T_DS, T_DP1, T_DP2, T_DP3, T_DP4, T_DP5, T_DP6 |
Contains options and flags for sending and receiving data such as serialisation method, data processors, encryption etc.
Several static constructors are provided to help create SendReceiveOptions in the most common formats.
| |
SendReceiveOptions T_DS, T_DP1, T_DP2, T_DP3, T_DP4, T_DP5, T_DP6, T_DP7 |
Contains options and flags for sending and receiving data such as serialisation method, data processors, encryption etc.
Several static constructors are provided to help create SendReceiveOptions in the most common formats.
| |
SerialisationException |
An error occurred while trying to serialise/compress or deserialise/uncompress an object.
| |
UnexpectedPacketTypeException |
An unexpected incoming packetType has been received. Consider setting NetworkComms.IgnoreUnknownPacketTypes to true to prevent this exception.
|
Interfaces
Interface | Description | |
---|---|---|
IPacket |
Interface for defining Application Layer Protocol packets
|
Delegates
Delegate | Description | |
---|---|---|
NetworkComms ConnectionEstablishShutdownDelegate |
Delegate which is executed when a connection is established or shutdown. See AppendGlobalConnectionEstablishHandler(NetworkComms ConnectionEstablishShutdownDelegate, Boolean) and AppendGlobalConnectionCloseHandler(NetworkComms ConnectionEstablishShutdownDelegate).
| |
NetworkComms PacketHandlerCallBackDelegate incomingObjectType |
Delegate for handling incoming packets. See AppendGlobalIncomingPacketHandler members.
|
Enumerations
Enumeration | Description | |
---|---|---|
ConnectionState |
Describes the current state of the connection
| |
PacketHeaderLongItems |
Any PacketHeader options which are stored as a long.
| |
PacketHeaderStringItems |
Any PacketHeader options which are stored as a string.
| |
RuntimeEnvironment |
Specifies the current runtime environment. Used for changing minor settings based on environment.
|