Loading...
Searching...
No Matches
Public Member Functions | List of all members
IDataDistribution Class Referenceabstract

Interface to be implemented from common manager. More...

#include <DataDistributionManager.h>

Inheritance diagram for IDataDistribution:
DataDistribution

Public Member Functions

virtual OPERATION_RESULT Initialize (IDataDistributionCallback *iddcb, const char *conf_file=NULL, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0
 Initialize IDataDistribution instance.
 
virtual OPERATION_RESULT Initialize (IDataDistributionCallback *iddcb, const char *arrayParams[], int len, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0
 Initialize IDataDistribution instance.
 
virtual OPERATION_RESULT RequestMastershipManager (IDataDistributionMastershipCallback *cbs, const char *szMyAddress=NULL, const char *arrayParams[]=NULL, int len=0)=0
 Allocate and initialize the mastership manager.
 
virtual BOOL Start (unsigned long timeout)=0
 Start the common manager.
 
virtual BOOL Stop (unsigned long timeout)=0
 Stop the common manager.
 
virtual IDataDistributionSubsystem * GetSubsystemManager ()=0
 Returns the allocated communication subsystem.
 
virtual IDataDistributionMastershipCommon * GetMastershipManager ()=0
 Returns the allocated mastership subsystem.
 
virtual std::string GetProtocol ()=0
 Returns the protocol in use from IDataDistribution instance.
 
virtual std::string GetProtocolLib ()=0
 Returns the protocol library in use from IDataDistribution instance.
 
virtual std::string GetMastershipLib ()=0
 Returns the mastership library in use from IDataDistribution instance.
 

Detailed Description

Interface to be implemented from common manager.

Interface to be implemented from common manager

Member Function Documentation

◆ GetMastershipLib()

virtual std::string IDataDistribution::GetMastershipLib ( )
pure virtual

Returns the mastership library in use from IDataDistribution instance.

Returns
the mastership library name

◆ GetMastershipManager()

virtual IDataDistributionMastershipCommon * IDataDistribution::GetMastershipManager ( )
pure virtual

Returns the allocated mastership subsystem.

Returns
IDataDistributionMastershipCommon of mastership subsystem

◆ GetProtocol()

virtual std::string IDataDistribution::GetProtocol ( )
pure virtual

Returns the protocol in use from IDataDistribution instance.

Returns
the protocol name

◆ GetProtocolLib()

virtual std::string IDataDistribution::GetProtocolLib ( )
pure virtual

Returns the protocol library in use from IDataDistribution instance.

Returns
the protocol library name

◆ GetSubsystemManager()

virtual IDataDistributionSubsystem * IDataDistribution::GetSubsystemManager ( )
pure virtual

Returns the allocated communication subsystem.

Returns
IDataDistributionSubsystem of communication subsystem

◆ Initialize() [1/2]

virtual OPERATION_RESULT IDataDistribution::Initialize ( IDataDistributionCallback *  iddcb,
const char *  arrayParams[],
int  len,
const char *  hostAddress = NULL,
const char *  channelTrailer = NULL 
)
pure virtual

Initialize IDataDistribution instance.

iddcb IDataDistributionCallback received from external user application arrayParams an array of string in the form key=value len length of arrayParams hostAddress optional host address or host name channelTrailer the optional trailer to be appended to channel name when each channel is created

Returns
the OPERATION_RESULT of the operation

◆ Initialize() [2/2]

virtual OPERATION_RESULT IDataDistribution::Initialize ( IDataDistributionCallback *  iddcb,
const char *  conf_file = NULL,
const char *  hostAddress = NULL,
const char *  channelTrailer = NULL 
)
pure virtual

Initialize IDataDistribution instance.

iddcb IDataDistributionCallback from external user application conf_file the external ASCII configuration file with lines written as key=value hostAddress optional host address or host name channelTrailer the optional trailer to be appended to channel name when each channel is created

Returns
the OPERATION_RESULT of the operation

◆ RequestMastershipManager()

virtual OPERATION_RESULT IDataDistribution::RequestMastershipManager ( IDataDistributionMastershipCallback *  cbs,
const char *  szMyAddress = NULL,
const char *  arrayParams[] = NULL,
int  len = 0 
)
pure virtual

Allocate and initialize the mastership manager.

cbs IDataDistributionMastershipCallback received from external user application hostAddress optional host address or host name arrayParams an array of string in the form key=value len length of arrayParams

Returns
the OPERATION_RESULT of the operation

◆ Start()

virtual BOOL IDataDistribution::Start ( unsigned long  timeout)
pure virtual

Start the common manager.

timeout the operation timeout in milliseconds

Returns
the OPERATION_RESULT of the operation

◆ Stop()

virtual BOOL IDataDistribution::Stop ( unsigned long  timeout)
pure virtual

Stop the common manager.

timeout the operation timeout in milliseconds

Returns
the OPERATION_RESULT of the operation
The documentation for this class was generated from the following file: