DOFConnection ClassOpenDOF Object Access Library
DOFConnection represents an ability to communicate with other nodes in a DOF network.
Inheritance Hierarchy

SystemObject
  org.opendof.core.oalDOFConnection

Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax

C#
public sealed class DOFConnection

The DOFConnection type exposes the following members.

Methods

  NameDescription
Public methodaddDomain
Dynamically add the credentials, which are used on a connection that supports authentication, to verify that the host being connected to is authorized to process authentication requests in the domain that is specified in the credentials.
Public methodaddPeerListener
Add a peer listener to this connection.
Public methodaddStateListener
Add a connection state-change handler to this connection.
Public methodaddTrustedDomain
Dynamically add in a configured TRP route without credentials.
Public methodbeginConnect(Int32)
Open a connection, waiting up to timeout for the connection to be established.
Public methodbeginConnect(Int32, DOFConnectionConnectOperationListener)
Open a connection, waiting up to timeout for the connection to be established.
Public methodbeginConnect(Int32, DOFConnectionConnectOperationListener, Object)
Open a connection, waiting up to timeout for the connection to be established.
Public methodbeginReconnect(Int32)
Re-open a connection, waiting up to timeout for the connection to be reestablished.
Public methodbeginReconnect(Int32, DOFConnectionConnectOperationListener)
Re-open a connection, waiting up to timeout for the connection to be reestablished.
Public methodbeginReconnect(Int32, DOFConnectionConnectOperationListener, Object)
Re-open a connection, waiting up to timeout for the connection to be reestablished.
Public methodconnect
Open a connection, waiting up to timeout for the connection to be established.
Public methodcreateConnection
Create a Type.POINT connection related to this connection. Anything else will fail. See Type.POINT for instructions to properly create a POINT connection.
Public methoddestroy
Destroy a connection, removing references to it.
Public methoddisconnect
Request that a connection be terminated.
Public methodEquals (Overrides ObjectEquals(Object).)
Public methodGetHashCode (Overrides ObjectGetHashCode.)
Public methodgetRelatedConnection
Return the connection that was created using DOFConnection.createConnection.
Public methodgetRelatedServer
Return the server that was created using DOFServer.createConnection.
Public methodgetState
Get the current instantaneous state of the connection.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodisConnected
Return whether or not the connection is currently connected.
Public methodreconnect
Reopen a connection, waiting up to timeout for the connection to be reestablished.
Public methodremoveDomain
Dynamically remove the connection from the TRP route associated with the credentials.
Public methodremovePeerListener
Remove a peer listener from this connection.
Public methodremoveStateListener
Remove a connection state-change handler from this connection.
Public methodremoveTrustedDomain
Remove the connection from the TRP router for the specified domain.
Public methodToString (Overrides ObjectToString.)
Top
Remarks

DOFConnection represents an ability to communicate with other nodes in a DOF network. This is different from a DOFServer because DOFServer represents the ability of other nodes in the network to communicate with the server node.

A DOFConnection represents all methods of communication, not just the typical point-to-point case. For example, membership in multicast groups is represented as a DOFConnection. Also, non-streaming "connections" use the DOFConnection.

DOFConnection represents a shared resource (the connection) that is actually managed inside the DOF. This means that a single DOFConnection represents only one of potentially multiple inputs to the DOF as to the desired state of the connection. This means, for example, that the StateListener s registered with this connection may be called because of state changes to the connection that are caused by other DOFConnections.

Constructing DOFConnection:

DOFConnection instances are constructed through the DOF with DOF.createConnection(Config) or from an existing connection with createConnection(Config) or from an instance of DOFConnection.State with State.createConnection() .

Special connection types:

See the respective type for instructions to properly create those connection types.
See Also

Reference