OpenDOF Project
Modules | Data Structures | Typedefs | Functions
DOFConnection
Distributed Object Framework (DOF)

Modules

 DOFConnectionConfig
 The DOFConnectionConfig class represents most of the information necessary for a DOF to create a connection.
 
 DOFConnectionList
 
 DOFConnectionState
 Represents the instantaneous state of a DOFConnection.
 
 DOFConnectionStreamRequest
 

Data Structures

struct  DOFConnectionList
 DOF DOFConnection List structure. More...
 

Typedefs

typedef struct DOFConnection_t * DOFConnection
 A connection definition.
 
typedef struct
DOFConnectionState_t * 
DOFConnectionState
 A snapshot of the current state of a DOFConnection.
 
typedef struct
DOFConnectionStreamRequest_t * 
DOFConnectionStreamRequest
 A representation of a request for a streaming connection.
 

Functions

void DOFConnection_Destroy (DOFConnection self)
 Destroy the DOFConnection and free all memory that was allocated for use by the connection.
 
boolean DOFConnection_Connect (DOFConnection self, uint32 timeout, DOFException *pException)
 Cause the Connection to become Connected, if possible.
 
void DOFConnection_BeginConnect (DOFConnection self, uint32 timeout, DOFConnectionConnectCallback callback, void *context)
 Cause the Connection to start connecting, if possible.
 
boolean DOFConnection_Reconnect (DOFConnection self, uint32 timeout, DOFException *pException)
 Cause the Connection to become Connected again, if possible.
 
void DOFConnection_BeginReconnect (DOFConnection self, uint32 timeout, DOFConnectionConnectCallback callback, void *context)
 Cause the Connection to start connecting again, if possible.
 
void DOFConnection_Disconnect (DOFConnection self)
 If connected then decrement the reference count associated with this DOFConnection, and if the result is zero then allow the Connection to close.
 
boolean DOFConnection_AddStateListener (DOFConnection self, DOFConnectionStateListener listener)
 Add a connection state listener to this DOFConnection.
 
void DOFConnection_RemoveStateListener (DOFConnection self, DOFConnectionStateListener listener)
 Remove a connection state listener from this DOFConnection.
 
boolean DOFConnection_AddPeerListener (DOFConnection self, DOFConnectionPeerListener listener)
 Add a connection peer listener to this DOFConnection.
 
void DOFConnection_RemovePeerListener (DOFConnection self, DOFConnectionPeerListener listener)
 Remove a connection peer listener from this DOFConnection.
 
DOFConnectionState DOFConnection_CreateState (const DOFConnection self)
 Return a snapshot of the current state of the Connection.
 
DOFServer DOFConnection_GetRelatedServer (const DOFConnection self)
 Return the Server associated with the Connection.
 
DOFConnection DOFConnection_GetRelatedConnection (const DOFConnection self)
 Return the Connection associated with the Connection.
 
DOFConnection DOFConnection_CreateConnection (DOFConnection self, DOFConnectionConfig config)
 Create a connection associated with a connection, including the ability to create a point connection (to a hub).
 
boolean DOFConnection_IsConnected (const DOFConnection self)
 Return whether the status of the Connection is connected or not.
 
boolean DOFConnection_AddDomain (DOFConnection self, DOFDomainConfig domain, uint32 timeout, DOFException *exception)
 Adds Domain Credentials to a connection.
 
void DOFConnection_RemoveDomain (DOFConnection self, DOFDomainConfig domain)
 Removes Domain Credentials from a connection.
 
boolean DOFConnection_AddTrustedDomain (DOFConnection self, DOFObjectIDDomain domain)
 Adds a Trusted Domain.
 
void DOFConnection_RemoveTrustedDomain (DOFConnection self, DOFObjectIDDomain domain)
 Removed a Trusted Domain that was added with DOFConnection_AddTrustedDomain.
 

Detailed Description

core-c-dof-oal Version 8.0.1 Build 0
2018-01-22