IDataDistributionSubsystem Class Reference

Interface to be implemented from subsystem. More...

#include <DataDistributionManager.h>

Inheritance diagram for IDataDistributionSubsystem:

Public Member Functions
virtual OPERATION_RESULT	Initialize (IDataDistributionCallback *cb, const char *conf_file, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0
	Initialize the subsystem.
virtual OPERATION_RESULT	Initialize (IDataDistributionCallback *cb, const char *arrayParams[], int len, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0
	Initialize the subsystem.
virtual IDataDistributionCallback *	GetCallbacks ()=0
	Returns IDataDistributionCallback passed during IDataDistributionSubsystem::Initialize.
Public Member Functions inherited from IDataDistributionTransport
virtual int	GetServerLostTimeout ()=0
	Returns the server lost timeout.
virtual size_t	GetMaxMessageSize ()=0
	Returns the max message size managed from the subsystem.
virtual OPERATION_RESULT	Start (unsigned long timeout)=0
	Start the transport subsystem.
virtual OPERATION_RESULT	Stop (unsigned long timeout)=0
	Start the transport subsystem.
Public Member Functions inherited from IDataDistributionChannelBase
virtual CHANNEL_HANDLE	CreateChannel (const char *channelName, IDataDistributionChannelCallback *dataCb, DDM_CHANNEL_DIRECTION direction=DDM_CHANNEL_DIRECTION::ALL, const char *arrayParams[]=NULL, int len=0)=0
	Creates a new channel.
virtual OPERATION_RESULT	StartChannel (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0
	Starts the channel.
virtual OPERATION_RESULT	StopChannel (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0
	Stops the channel.
virtual void	SetParameter (CHANNEL_HANDLE_PARAMETER, const char *paramName, const char *paramValue)=0
	Sets a parameter at run-time.
virtual void	SetParameter (CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId, const char *paramValue)=0
	Sets a parameter at run-time.
virtual const char *	GetParameter (CHANNEL_HANDLE_PARAMETER, const char *paramName)=0
	Reads a parameter at run-time.
virtual const char *	GetParameter (CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId)=0
	Reads a parameter at run-time.
virtual OPERATION_RESULT	Lock (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0
	Locks the channel.
virtual OPERATION_RESULT	Unlock (CHANNEL_HANDLE_PARAMETER)=0
	Unlock the channel.
virtual OPERATION_RESULT	SeekChannel (CHANNEL_HANDLE_PARAMETER, int64_t position, DDM_SEEKCONTEXT context=DDM_SEEKCONTEXT::OFFSET, DDM_SEEKKIND kind=DDM_SEEKKIND::ABSOLUTE)=0
	Seeks the channel.
virtual OPERATION_RESULT	DeleteChannel (CHANNEL_HANDLE_PARAMETER)=0
	Deletes the channel.
virtual OPERATION_RESULT	WriteOnChannel (CHANNEL_HANDLE_PARAMETER, const char *key, size_t keyLen, void *buffer, size_t bufferLen, const BOOL waitAll=FALSE, const int64_t timestamp=DDM_NO_TIMESTAMP)=0
	Writes data on the channel.
virtual OPERATION_RESULT	ReadFromChannel (CHANNEL_HANDLE_PARAMETER, int64_t offset, size_t *bufferLen, void **buffer)=0
	Reads data from the channel.
virtual OPERATION_RESULT	ChangeChannelDirection (CHANNEL_HANDLE_PARAMETER, DDM_CHANNEL_DIRECTION direction)=0
	Change the DDM_CHANNEL_DIRECTION of the channel.
Public Member Functions inherited from IDataDistributionLog
virtual void	Log (const DDM_LOG_LEVEL level, const char *sourceName, const char *function, const char *format,...)=0
	Reports log information.
virtual void	Log (const DDM_LOG_LEVEL level, const char *sourceName, const char *function, const char *format, va_list args)=0
	Reports log information.

Detailed Description

Interface to be implemented from subsystem.

Interface to be implemented from subsystem. Extends IDataDistributionTransport and IDataDistributionLog

Member Function Documentation

GetCallbacks()

virtual IDataDistributionCallback * IDataDistributionSubsystem::GetCallbacks ( )

pure virtual

Returns IDataDistributionCallback passed during IDataDistributionSubsystem::Initialize.

Returns

IDataDistributionCallback

Initialize() [1/2]

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

pure virtual

Initialize the subsystem.

cb IDataDistributionCallback received from IDataDistribution::Initialize 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 IDataDistributionSubsystem::Initialize ( IDataDistributionCallback * cb, const char * conf_file, const char * hostAddress = NULL, const char * channelTrailer = NULL )

pure virtual

Initialize the subsystem.

cb IDataDistributionCallback received from IDataDistribution::Initialize 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

---

The documentation for this class was generated from the following file:

• D:/a/DataDistributionManager/DataDistributionManager/src/native/DataDistributionManager/DataDistributionManager.h