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

Represents a DOF node server. More...

Modules

 DOFServerConfig
 The DOFServerConfig class represents most of the information necessary for a DOF to create a server.
 
 DOFServerList
 
 DOFServerState
 Represents the instantaneous state of a DOFServer.
 

Files

file  oal.h
 Header file for the C OAL functions, defines and data types.
 

Data Structures

struct  DOFServerList
 DOF DOFServer List structure. More...
 

Typedefs

typedef struct DOFServer_t * DOFServer
 A representation of a standard DOF server.
 
typedef struct DOFServerState_t * DOFServerState
 A snapshot of the current state of a DOFServer.
 

Functions

DOFServer DOFServer_CreateServer (DOFServer self, DOFServerConfig config)
 Creates a server based on server passed in.
 
void DOFServer_Destroy (DOFServer self)
 Stops and destroys a DOFServer.
 
boolean DOFServer_Start (DOFServer self, uint32 timeout, DOFException *pException)
 Causes the Server to become Started.
 
void DOFServer_BeginStart (DOFServer self, uint32 timeout, DOFServerStartCallback callback, void *context)
 Causes the Server to become Started.
 
boolean DOFServer_Restart (DOFServer self, uint32 timeout, DOFException *pException)
 Causes the Server to become Started again, if possible.
 
void DOFServer_BeginRestart (DOFServer self, uint32 timeout, DOFServerStartCallback callback, void *context)
 Causes the Server to start again, if possible.
 
void DOFServer_Stop (DOFServer self)
 Stops a server and disconnects existing inbound connections to the server.
 
DOFServerConfig DOFServer_GetConfig (const DOFServer self)
 Returns the given DOFServer's DOFServerConfig.
 
DOFConnection DOFServer_CreateConnection (DOFServer self, DOFConnectionConfig config)
 Creates a connection associated with a server, including the ability to join multicast groups.
 
boolean DOFServer_AddStateListener (DOFServer self, DOFServerStateListener listener)
 Adds a listener to DOFServer that notify user of state change of a server.
 
void DOFServer_RemoveStateListener (DOFServer self, DOFServerStateListener listener)
 Removes listener from a DOFServer.
 
DOFServerState DOFServer_CreateState (const DOFServer self)
 Returns a snapshot of the current state of the Server.
 
boolean DOFServer_IsStarted (const DOFServer self)
 Returns whether the status of the Server is connected or not.
 

Detailed Description

Represents a DOF node server.

core-c-dof-oal Version 7.1.5 Build 0
2017-01-25