NetworkCommsDotNet NamespaceNetworkComms.Net Help
Base library providing methods to track connections, global configurations, send and receive objects.
Classes

  ClassDescription
Public classCheckSumException
A checksum error has occurred. NetworkComms.EnablePacketCheckSumValidation must be set to true for this exception to be thrown.
Public classCommsException
Base exception. All connection related exceptions can be caught in a single catch block by using catch(CommsException)
Public classCommsSetupShutdownException
An error occurred while trying to setup or shutdown NetworkComms.Net
Public classCommunicationException
An error occurred while during communication which does not fall under other exception cases.
Public classConfirmationTimeoutException
A timeout has occurred while waiting for a confirmation packet to be received. Check for errors and or consider increasing NetworkComms.PacketConfirmationTimeoutMS
Public classConnectionInfo
Contains any information related to the configuration of a Connection object.
Public classConnectionSendTimeoutException
A connection send has timed out.
Public classConnectionSetupException
An error occurred while trying to establish a Connection
Public classConnectionShutdownException
An error occurred while trying to establish a Connection
Public classDuplicateConnectionException
A possible duplicate connection has been detected.
Public classExpectedReturnTimeoutException
A timeout has occurred while waiting for an expected return object. Check for errors and or consider increasing the provided return timeout value.
Public classInvalidNetworkIdentifierException
An invalid network identifier has been provided.
Public classNetworkComms
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.
Public classPacket
Wrapper for PacketHeader and packetData.
Public classPacketHandlerException
An error occurred during a packetType data handler execution.
Public classPacketHeader
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.
Public classSendReceiveOptions
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.
Public classSendReceiveOptions 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.
Public classSendReceiveOptions 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.
Public classSendReceiveOptions 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.
Public classSendReceiveOptions 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.
Public classSendReceiveOptions 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.
Public classSendReceiveOptions 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.
Public classSendReceiveOptions 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.
Public classSendReceiveOptions 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.
Public classSerialisationException
An error occurred while trying to serialise/compress or deserialise/uncompress an object.
Public classUnexpectedPacketTypeException
An unexpected incoming packetType has been received. Consider setting NetworkComms.IgnoreUnknownPacketTypes to true to prevent this exception.
Interfaces

  InterfaceDescription
Public interfaceIPacket
Interface for defining Application Layer Protocol packets
Delegates

  DelegateDescription
Public delegateNetworkComms ConnectionEstablishShutdownDelegate
Public delegateNetworkComms PacketHandlerCallBackDelegate incomingObjectType 
Delegate for handling incoming packets. See AppendGlobalIncomingPacketHandler members.
Enumerations

  EnumerationDescription
Public enumerationConnectionState
Describes the current state of the connection
Public enumerationPacketHeaderLongItems
Any PacketHeader options which are stored as a long.
Public enumerationPacketHeaderStringItems
Any PacketHeader options which are stored as a string.
Public enumerationRuntimeEnvironment
Specifies the current runtime environment. Used for changing minor settings based on environment.