IPConnection MethodsNetworkComms.Net Help
The IPConnection type exposes the following members.
Methods

  NameDescription
Public methodAppendIncomingPacketHandler incomingObjectType (String, NetworkComms PacketHandlerCallBackDelegate incomingObjectType )
Append a connection specific packet handler using the connection default SendReceiveOptions
(Inherited from Connection.)
Public methodAppendIncomingPacketHandler incomingObjectType (String, NetworkComms PacketHandlerCallBackDelegate incomingObjectType , SendReceiveOptions)
Append a connection specific packet handler
(Inherited from Connection.)
Public methodAppendIncomingUnmanagedPacketHandler
Append a connection specific unmanaged packet handler
(Inherited from Connection.)
Public methodAppendShutdownHandler
Add a connection specific shutdown delegate
(Inherited from Connection.)
Public methodCloseConnection
Closes the connection and trigger any associated shutdown delegates.
(Inherited from Connection.)
Protected methodCloseConnectionSpecific
Every connection will probably have to perform connection specific shutdown tasks. This is called before the global connection close tasks.
(Inherited from Connection.)
Public methodConnectionAlive 
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.)
Public methodConnectionAlive(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.)
Public methodConnectionAlive(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.)
Protected methodConnectionHandshake
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.)
Public methodDispose
Dispose of the connection. Recommended usage is to call CloseConnection instead.
(Inherited from Connection.)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Public methodEstablishConnection
Establish this connection
(Inherited from Connection.)
Protected methodEstablishConnectionSpecific
Any connection type specific establish tasks. Should call at least ConnectionHandshake() or TriggerConnectionEstablishDelegates();
(Inherited from Connection.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodIncomingPacketHandleHandOff
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.)
Public methodIncomingPacketHandlerExists(String)
Returns true if an unmanaged packet handler exists on this connection
(Inherited from Connection.)
Public methodIncomingPacketHandlerExists(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.)
Public methodIncomingUnmanagedPacketHandlerExists 
Returns true if a connection specific unmanaged packet handler exists, on this connection.
(Inherited from Connection.)
Public methodIncomingUnmanagedPacketHandlerExists(Delegate)
Returns true if the provided connection specific unmanaged packet handler has been added, on this connection.
(Inherited from Connection.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodPacketTypeUnwrapperOptions
Returns the packet type sendReceiveOptions possibly used to unwrap incoming data. If no specific options are registered returns null
(Inherited from Connection.)
Public methodRemoveIncomingPacketHandler 
Removes all packet handlers for all packet types, on this connection.
(Inherited from Connection.)
Public methodRemoveIncomingPacketHandler(String)
Removes all connection specific packet handlers for the provided packet type, on this connection.
(Inherited from Connection.)
Public methodRemoveIncomingPacketHandler(String, Delegate)
Remove the provided connection specific packet handler for the specified packet type, on this connection.
(Inherited from Connection.)
Public methodRemoveIncomingUnmanagedPacketHandler 
Removes all unmanaged packet handlers, on this connection.
(Inherited from Connection.)
Public methodRemoveIncomingUnmanagedPacketHandler(Delegate)
Remove the provided connection specific unmanaged packet handler, on this connection.
(Inherited from Connection.)
Public methodRemoveShutdownHandler
Remove a connection specific shutdown delegate.
(Inherited from Connection.)
Public methodSendObject(String)
Send an empty packet using the provided packetType. Useful for signalling.
(Inherited from Connection.)
Public methodSendObject(String, Int64 )
Send an empty packet using the provided packetType. Useful for signalling.
(Inherited from Connection.)
Public methodSendObject sendObjectType (String, sendObjectType)
Send an object using the connection default SendReceiveOptions
(Inherited from Connection.)
Public methodSendObject sendObjectType (String, sendObjectType, SendReceiveOptions)
Send an object using the provided SendReceiveOptions
(Inherited from Connection.)
Public methodSendObject sendObjectType (String, sendObjectType, Int64 )
Send an object using the connection default SendReceiveOptions
(Inherited from Connection.)
Public methodSendObject sendObjectType (String, sendObjectType, SendReceiveOptions, Int64 )
Send an object using the provided SendReceiveOptions
(Inherited from Connection.)
Public methodSendPacket packetPayloadObjectType (IPacket)
Send the provided packet to the remoteEndPoint. Waits for receive confirmation if required.
(Inherited from Connection.)
Public methodSendPacket packetPayloadObjectType (IPacket, Int64 )
Send the provided packet to the remoteEndPoint. Waits for receive confirmation if required.
(Inherited from Connection.)
Public methodSendReceiveObject 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.)
Public methodSendReceiveObject 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.)
Public methodSendReceiveObject 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.)
Public methodSendReceiveObject 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.)
Public methodSendReceiveObject 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.)
Public methodSendReceiveObject 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.)
Protected methodSendStreams
Connection specific implementation for sending data on this connection type. Each StreamSendWrapper[] represents a single expected packet.
(Inherited from Connection.)
Public methodSendUnmanagedBytes
Send bytes on an unmanaged connection
(Inherited from Connection.)
Protected methodStartIncomingDataListen
A connection specific method which triggers any requisites for accepting incoming data
(Inherited from Connection.)
Public methodToString
Returns ConnectionInfo.ToString
(Inherited from Connection.)
Protected methodTriggerConnectionEstablishDelegates
Trigger connection establish delegates.
(Inherited from Connection.)
Public methodTriggerSpecificPacketHandlers
Trigger connection specific packet delegates with the provided parameters. Returns true if connection specific handlers were executed.
(Inherited from Connection.)
Protected methodWaitForConnectionEstablish
Return true if the connection is established within the provided timeout, otherwise false
(Inherited from Connection.)
Back to Top
See Also