The UDPConnection type exposes the following members.
Back to Top
Back to Top
Back to Top
Methods
Name | Description | |
---|---|---|
AppendIncomingPacketHandler incomingObjectType (String, NetworkComms PacketHandlerCallBackDelegate incomingObjectType ) |
Append a connection specific packet handler using the connection default SendReceiveOptions
(Inherited from Connection.) | |
AppendIncomingPacketHandler incomingObjectType (String, NetworkComms PacketHandlerCallBackDelegate incomingObjectType , SendReceiveOptions) |
Append a connection specific packet handler
(Inherited from Connection.) | |
AppendIncomingUnmanagedPacketHandler |
Append a connection specific unmanaged packet handler
(Inherited from Connection.) | |
AppendShutdownHandler |
Add a connection specific shutdown delegate
(Inherited from Connection.) | |
CloseConnection |
Closes the connection and trigger any associated shutdown delegates.
(Inherited from Connection.) | |
CloseConnectionSpecific |
Every connection will probably have to perform connection specific shutdown tasks. This is called before the global
connection close tasks.
(Overrides Connection CloseConnectionSpecific(Boolean, Int32).) | |
ConnectionAlive |
Uses the current connection and returns a bool dependant on the remote end responding to a SendReceiveObject call
within the default ConnectionAliveTestTimeoutMS (Inherited from Connection.) | |
ConnectionAlive(Int32) |
Uses the current connection and returns a bool dependant on the remote end responding to a SendReceiveObject call
within the provided aliveRespondTimeoutMS.
(Inherited from Connection.) | |
ConnectionAlive(Int32, Int64 ) |
Uses the current connection and returns a bool dependant on the remote end responding to a SendReceiveObject call
within the provided aliveRespondTimeoutMS
(Inherited from Connection.) | |
ConnectionHandshake |
Performs a connection handshake with the remote end of the connection.
Exchanges network identifier and any listener whose IPAddress matches the connection localEndPoint IPAddress.
(Inherited from Connection.) | |
Dispose |
Dispose of the connection. Recommended usage is to call CloseConnection instead.
(Inherited from Connection.) | |
Equals | (Inherited from Object.) | |
EstablishConnection |
Establish this connection
(Inherited from Connection.) | |
EstablishConnectionSpecific |
Any connection type specific establish tasks. Should call at least ConnectionHandshake() or TriggerConnectionEstablishDelegates();
(Overrides Connection EstablishConnectionSpecific .) | |
ExistingLocalListenEndPoints | Obsolete.
Returns a list of IPEndPoint corresponding with all UDP local listeners
| |
ExistingLocalListenEndPoints(IPAddress) | Obsolete.
Returns an IPEndPoint corresponding to a possible local listener on the provided IPAddress.
If not listening on provided IPAddress returns null.
| |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetConnection(ConnectionInfo, UDPOptions, Boolean, Boolean) |
Create a UDP connection with the provided connectionInfo. If there is an existing connection that is returned instead.
If a new connection is created it will be registered with NetworkComms and can be retrieved using
GetExistingConnection(ConnectionInfo) and overrides.
| |
GetConnection(ConnectionInfo, UDPOptions, SendReceiveOptions, Boolean, Boolean) |
Create a UDP connection with the provided connectionInfo and and sets the connection default SendReceiveOptions.
If there is an existing connection that is returned instead. If a new connection is created it will be registered
with NetworkComms and can be retrieved using GetExistingConnection(ConnectionInfo).
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IncomingPacketHandleHandOff |
Attempts to use the data provided in packetBuilder to recreate something useful. If we don't have enough data
yet that value is set in packetBuilder.
(Inherited from Connection.) | |
IncomingPacketHandlerExists(String) |
Returns true if an unmanaged packet handler exists on this connection
(Inherited from Connection.) | |
IncomingPacketHandlerExists(String, Delegate) |
Returns true if the provided connection specific packet handler has been added for the provided packet type, on this connection.
(Inherited from Connection.) | |
IncomingUnmanagedPacketHandlerExists |
Returns true if a connection specific unmanaged packet handler exists, on this connection.
(Inherited from Connection.) | |
IncomingUnmanagedPacketHandlerExists(Delegate) |
Returns true if the provided connection specific unmanaged packet handler has been added, on this connection.
(Inherited from Connection.) | |
Listening | Obsolete.
Returns true if listening for new UDP connections.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
PacketTypeUnwrapperOptions |
Returns the packet type sendReceiveOptions possibly used to unwrap incoming data. If no specific options are registered returns null
(Inherited from Connection.) | |
RemoveIncomingPacketHandler |
Removes all packet handlers for all packet types, on this connection.
(Inherited from Connection.) | |
RemoveIncomingPacketHandler(String) |
Removes all connection specific packet handlers for the provided packet type, on this connection.
(Inherited from Connection.) | |
RemoveIncomingPacketHandler(String, Delegate) |
Remove the provided connection specific packet handler for the specified packet type, on this connection.
(Inherited from Connection.) | |
RemoveIncomingUnmanagedPacketHandler |
Removes all unmanaged packet handlers, on this connection.
(Inherited from Connection.) | |
RemoveIncomingUnmanagedPacketHandler(Delegate) |
Remove the provided connection specific unmanaged packet handler, on this connection.
(Inherited from Connection.) | |
RemoveShutdownHandler |
Remove a connection specific shutdown delegate.
(Inherited from Connection.) | |
SendObject(String) |
Send an empty packet using the provided packetType. Useful for signalling.
(Inherited from Connection.) | |
SendObject(String, Int64 ) |
Send an empty packet using the provided packetType. Useful for signalling.
(Inherited from Connection.) | |
SendObject(String, Object, IPEndPoint) |
Sends a single object to the provided endPoint. NOTE: Any possible reply will be ignored unless listening for incoming UDP packets.
| |
SendObject(String, Object, IPEndPoint, SendReceiveOptions) |
Sends a single object to the provided endPoint. NOTE: Any possible reply will be ignored unless listening for incoming UDP packets.
| |
SendObject(String, Object, String, Int32) |
Sends a single object to the provided IPAddress and Port. NOTE: Any possible reply will be ignored unless listening
for incoming UDP packets.
| |
SendObject sendObjectType (String, sendObjectType) |
Send an object using the connection default SendReceiveOptions (Inherited from Connection.) | |
SendObject sendObjectType (String, sendObjectType, SendReceiveOptions) |
Send an object using the provided SendReceiveOptions
(Inherited from Connection.) | |
SendObject sendObjectType (String, sendObjectType, Int64 ) |
Send an object using the connection default SendReceiveOptions (Inherited from Connection.) | |
SendObject sendObjectType (String, sendObjectType, SendReceiveOptions, Int64 ) |
Send an object using the provided SendReceiveOptions
(Inherited from Connection.) | |
SendObject packetPayloadObjectType (IPacket, IPEndPoint, SendReceiveOptions, ApplicationLayerProtocolStatus) |
Sends a Packet to the provided endPoint. Offers more performance if an identical packet is being sent to multiple peers.
NOTE: Any possible reply will be ignored unless listening for incoming UDP packets.
| |
SendObject sendObjectType (String, sendObjectType, IPEndPoint, SendReceiveOptions, ApplicationLayerProtocolStatus) |
Sends a single object to the provided endPoint. NOTE: Any possible reply will be ignored unless listening for incoming UDP packets.
| |
SendPacket packetPayloadObjectType (IPacket) |
Send the provided packet to the remoteEndPoint. Waits for receive confirmation if required.
(Inherited from Connection.) | |
SendPacket packetPayloadObjectType (IPacket, Int64 ) |
Send the provided packet to the remoteEndPoint. Waits for receive confirmation if required.
(Inherited from Connection.) | |
SendReceiveObject returnObjectType (String, String, Int32) |
Send an empty packet using the connection default SendReceiveOptions and wait for a returned object again
using default SendReceiveOptions. Useful to request an object when there is no need to send anything.
(Inherited from Connection.) | |
SendReceiveObject returnObjectType (String, String, Int32, Int64 ) |
Send an empty packet using the connection default SendReceiveOptions and wait for a returned object again using default SendReceiveOptions. Usefull to request an object when there is no need to send anything.
(Inherited from Connection.) | |
SendReceiveObject sendObjectType, returnObjectType (String, String, Int32, sendObjectType) |
Send an object using the connection default SendReceiveOptions and wait for a returned object
again using default SendReceiveOptions.
(Inherited from Connection.) | |
SendReceiveObject sendObjectType, returnObjectType (String, String, Int32, sendObjectType, Int64 ) |
Send an object using the connection default SendReceiveOptions and wait for a returned object again
using default SendReceiveOptions.
(Inherited from Connection.) | |
SendReceiveObject sendObjectType, returnObjectType (String, String, Int32, sendObjectType, SendReceiveOptions, SendReceiveOptions) |
Send an object using the provided SendReceiveOptions and wait for a returned object using provided
SendReceiveOptions.
(Inherited from Connection.) | |
SendReceiveObject sendObjectType, returnObjectType (String, String, Int32, sendObjectType, SendReceiveOptions, SendReceiveOptions, Int64 ) |
Send an object using the provided SendReceiveOptions and wait for a returned object using provided
SendReceiveOptions.
(Inherited from Connection.) | |
SendStreams |
Connection specific implementation for sending data on this connection type.
Each StreamSendWrapper[] represents a single expected packet.
(Overrides Connection SendStreams( StreamTools StreamSendWrapper , Double, Int64).) | |
SendUnmanagedBytes |
Send bytes on an unmanaged connection
(Inherited from Connection.) | |
StartIncomingDataListen |
A connection specific method which triggers any requisites for accepting incoming data
(Overrides Connection StartIncomingDataListen .) | |
StartListening(Boolean) | Obsolete.
Listen for incoming UDP packets on all allowed local IP's on default port.
| |
StartListening(List IPEndPoint , Boolean) | Obsolete.
Listen for incoming UDP packets on provided list of IPEndPoint.
| |
StartListening(IPEndPoint, Boolean, Boolean) | Obsolete.
Listen for incoming UDP packets on specified IPEndPoint.
| |
ToString |
Returns ConnectionInfo.ToString
(Inherited from Connection.) | |
TriggerConnectionEstablishDelegates |
Trigger connection establish delegates.
(Inherited from Connection.) | |
TriggerSpecificPacketHandlers |
Trigger connection specific packet delegates with the provided parameters. Returns true if connection specific handlers were executed.
(Inherited from Connection.) | |
WaitForConnectionEstablish |
Return true if the connection is established within the provided timeout, otherwise false
(Inherited from Connection.) |
Fields
Name | Description | |
---|---|---|
asyncListenerInRead |
True if the async listen method is in a beginRead
(Inherited from Connection.) | |
asyncListenStarted |
True if async listen has started
(Inherited from Connection.) | |
connectionEstablishWait |
A manual reset event which can be used to handle connection setup and establish.
(Inherited from Connection.) | |
connectionSetupException |
A boolean used to signal a connection setup exception.
(Inherited from Connection.) | |
connectionSetupExceptionStr |
If connectionSetupException is true provides additional exception information.
(Inherited from Connection.) | |
connectionSetupWait |
A manual reset event which can be used to handle connection setup and establish.
(Inherited from Connection.) | |
incomingDataListenThread |
The thread listening for incoming data should we be using synchronous methods.
(Inherited from Connection.) | |
packetBuilder |
The PacketBuilder for this connection
(Inherited from Connection.) | |
packetSequenceCounter |
A counter which is incremented during every a send. The current value is included in the header of all sent packets.
(Inherited from Connection.) | |
sendLocker |
Lockers for maintaining thread safe operation
(Inherited from Connection.) | |
SendTimesMSPerKBCache |
A NetworkComms.Net math object for tracking send times. Used to prevent send deadlocks.
Initialised at 1000 milliseconds per KB write speed, corresponding with 1KB / second.
(Inherited from Connection.) | |
totalBytesRead |
The total bytes read so far within dataBuffer
(Inherited from Connection.) |
Properties
Name | Description | |
---|---|---|
ConnectionDefaultSendReceiveOptions |
The default SendReceiveOptions used for this connection
(Inherited from Connection.) | |
ConnectionInfo |
Connection information related to this connection.
(Inherited from Connection.) | |
ConnectionUDPOptions |
Options associated with this UDPConnection
| |
DefaultUDPOptions |
The default UDPOptions to use where none are otherwise specified.
| |
IgnoreICMPDestinationUnreachable |
By default a UDP datagram sent to an unreachable destination will result in an ICMP Destination Unreachable
packet. This can result in a SocketException on the local end. To avoid this behaviour these ICMP packets
are ignored by default, i.e. this value is set to true. Setting this value to false could cause new UDP
connections to close, possibly unexpectedly.
| |
SyncRoot |
Connection level SyncRoot which can be used to perform multiple thread safe operations on this connection
external to NetworkComms.Net
(Inherited from Connection.) |
See Also