Package org.mases.datadistributionmanager

Interface ISmartDataDistributionChannel

All Superinterfaces:

ISmartDataDistributionChannelInfo

All Known Implementing Classes:

SmartDataDistributionChannel

public interface ISmartDataDistributionChannel
extends ISmartDataDistributionChannelInfo

Method Summary

Modifier and Type	Method	Description
void	addListener(IConditionOrErrorListener listener)	Adds a IConditionOrErrorListener listener
void	addListener(IDataAvailableListener listener)	Adds a IDataAvailableListener listener
OPERATION_RESULT	ChangeDirectionOnChannel(DDM_CHANNEL_DIRECTION direction)	Change direction of the channel
java.lang.String	GetParameter(java.lang.String paramName)	Get parameter from channel
java.lang.String	GetParameter(DDM_GENERAL_PARAMETER paramId)	Get parameter from channel
OPERATION_RESULT	Lock(int timeout)	Locks the channel
byte[]	ReadFromChannel(long offset, long length)	Reads from the channel
void	removeListener(IConditionOrErrorListener listener)	Removes a IConditionOrErrorListener listener
void	removeListener(IDataAvailableListener listener)	Removes a IDataAvailableListener listener
OPERATION_RESULT	SeekChannel(long position)	Seek the channel using absolute offset
OPERATION_RESULT	SeekChannel(long position, DDM_SEEKCONTEXT context, DDM_SEEKKIND kind)	Seek the channel using absolute or relative offset
OPERATION_RESULT	SeekChannel(long position, DDM_SEEKKIND kind)	Seek the channel using absolute or relative offset
OPERATION_RESULT	SeekChannel(java.time.Duration position)	Seek the channel by a relative time expressed as Duration starting from latest known timestamp
OPERATION_RESULT	SeekChannel(java.util.Date position)	Seek the channel to an absolute timestamp
void	SetParameter(java.lang.String paramName, java.lang.String paramValue)	Set parameter on channel
void	SetParameter(DDM_GENERAL_PARAMETER paramId, java.lang.String paramValue)	Set parameter on channel
OPERATION_RESULT	StartChannel(int timeout)	Starts the channel
OPERATION_RESULT	StopChannel(int timeout)	Stops the channel
OPERATION_RESULT	Unlock()	Unlocks the channel
OPERATION_RESULT	WriteOnChannel(byte[] buffer)	Writes on the channel
OPERATION_RESULT	WriteOnChannel(java.lang.String value)	Writes on the channel
OPERATION_RESULT	WriteOnChannel(java.lang.String key, byte[] buffer)	Writes on the channel
OPERATION_RESULT	WriteOnChannel(java.lang.String key, byte[] buffer, boolean waitAll)	Writes on the channel
OPERATION_RESULT	WriteOnChannel(java.lang.String key, byte[] buffer, boolean waitAll, long timestamp)	Writes on the channel
OPERATION_RESULT	WriteOnChannel(java.lang.String key, java.lang.String value)	Writes on the channel
OPERATION_RESULT	WriteOnChannel(java.lang.String key, java.lang.String value, boolean waitAll)	Writes on the channel
OPERATION_RESULT	WriteOnChannel(java.lang.String key, java.lang.String value, boolean waitAll, long timestamp)	Writes on the channel

Methods inherited from interface org.mases.datadistributionmanager.ISmartDataDistributionChannelInfo

getChannelName, getOffset, getTimestamp

Method Detail

StartChannel

OPERATION_RESULT StartChannel(int timeout)

Starts the channel

Parameters:

timeout - Timeout in ms

Returns:

OPERATION_RESULT

StopChannel

OPERATION_RESULT StopChannel(int timeout)

Stops the channel

Parameters:

timeout - Timeout in ms

Returns:

OPERATION_RESULT

SetParameter

void SetParameter(java.lang.String paramName,
                  java.lang.String paramValue)

Set parameter on channel

Parameters:

paramName - Parameter name to set

paramValue - Parameter value to set

SetParameter

void SetParameter(DDM_GENERAL_PARAMETER paramId,
                  java.lang.String paramValue)

Set parameter on channel

Parameters:

paramId - Parameter DDM_GENERAL_PARAMETER to set

paramValue - Parameter value to set

GetParameter

java.lang.String GetParameter(java.lang.String paramName)

Get parameter from channel

Parameters:

paramName - Parameter name to get

Returns:

Parameter value

GetParameter

java.lang.String GetParameter(DDM_GENERAL_PARAMETER paramId)

Get parameter from channel

Parameters:

paramId - Parameter DDM_GENERAL_PARAMETER to get

Returns:

Parameter value

Lock

OPERATION_RESULT Lock(int timeout)

Locks the channel

Parameters:

timeout - Timeout in ms

Returns:

OPERATION_RESULT

Unlock

OPERATION_RESULT Unlock()

Unlocks the channel

Returns:

OPERATION_RESULT

SeekChannel

OPERATION_RESULT SeekChannel(long position)

Seek the channel using absolute offset

Parameters:

position - Seek offset poisition

Returns:

OPERATION_RESULT

SeekChannel

OPERATION_RESULT SeekChannel(long position,
                             DDM_SEEKKIND kind)

Seek the channel using absolute or relative offset

Parameters:

position - Seek offset poisition

kind - DDM_SEEKKIND to use

Returns:

OPERATION_RESULT

SeekChannel

OPERATION_RESULT SeekChannel(java.util.Date position)

Seek the channel to an absolute timestamp

Parameters:

position - Seek timestamp to an absolute poisition

Returns:

OPERATION_RESULT

SeekChannel

OPERATION_RESULT SeekChannel(java.time.Duration position)

Seek the channel by a relative time expressed as Duration starting from latest known timestamp

Parameters:

position - Seek timestamp relative poisition

Returns:

OPERATION_RESULT

SeekChannel

OPERATION_RESULT SeekChannel(long position,
                             DDM_SEEKCONTEXT context,
                             DDM_SEEKKIND kind)

Seek the channel using absolute or relative offset

Parameters:

position - Seek offset poisition

context - DDM_SEEKCONTEXT to use

kind - DDM_SEEKKIND to use

Returns:

OPERATION_RESULT

WriteOnChannel

OPERATION_RESULT WriteOnChannel(java.lang.String value)

Writes on the channel

Parameters:

value - The String to write in the channel

Returns:

OPERATION_RESULT

WriteOnChannel

OPERATION_RESULT WriteOnChannel(java.lang.String key,
                                java.lang.String value)

Writes on the channel

Parameters:

key - The key to use

value - The String to write in the channel

Returns:

OPERATION_RESULT

WriteOnChannel

OPERATION_RESULT WriteOnChannel(java.lang.String key,
                                java.lang.String value,
                                boolean waitAll)

Writes on the channel

Parameters:

key - The key to use

value - The String to write in the channel

waitAll - waits all write in the distributed environment

Returns:

OPERATION_RESULT

WriteOnChannel

OPERATION_RESULT WriteOnChannel(java.lang.String key,
                                java.lang.String value,
                                boolean waitAll,
                                long timestamp)

Writes on the channel

Parameters:

key - The key to use

value - The String to write in the channel

waitAll - waits all write in the distributed environment

timestamp - timestamp to apply

Returns:

OPERATION_RESULT

WriteOnChannel

OPERATION_RESULT WriteOnChannel(byte[] buffer)

Writes on the channel

Parameters:

buffer - The buffer to write in the channel

Returns:

OPERATION_RESULT

WriteOnChannel

OPERATION_RESULT WriteOnChannel(java.lang.String key,
                                byte[] buffer)

Writes on the channel

Parameters:

key - The key to use

buffer - The buffer to write in the channel

Returns:

OPERATION_RESULT

WriteOnChannel

OPERATION_RESULT WriteOnChannel(java.lang.String key,
                                byte[] buffer,
                                boolean waitAll)

Writes on the channel

Parameters:

key - The key to use

buffer - The buffer to write in the channel

waitAll - waits all write in the distributed environment

Returns:

OPERATION_RESULT

WriteOnChannel

OPERATION_RESULT WriteOnChannel(java.lang.String key,
                                byte[] buffer,
                                boolean waitAll,
                                long timestamp)

Writes on the channel

Parameters:

key - The key to use

buffer - The buffer to write in the channel

waitAll - waits all write in the distributed environment

timestamp - timestamp to apply

Returns:

OPERATION_RESULT

ReadFromChannel

byte[] ReadFromChannel(long offset,
                       long length)

Reads from the channel

Parameters:

offset - offset in the stream

length - number of elements

Returns:

an array of byte

ChangeDirectionOnChannel

OPERATION_RESULT ChangeDirectionOnChannel(DDM_CHANNEL_DIRECTION direction)

Change direction of the channel

Parameters:

direction - DDM_CHANNEL_DIRECTION

Returns:

OPERATION_RESULT

addListener

void addListener(IDataAvailableListener listener)

Adds a IDataAvailableListener listener

Parameters:

listener - IDataAvailableListener listener to add

removeListener

void removeListener(IDataAvailableListener listener)

Removes a IDataAvailableListener listener

Parameters:

listener - IDataAvailableListener listener to remove

addListener

void addListener(IConditionOrErrorListener listener)

Adds a IConditionOrErrorListener listener

Parameters:

listener - IConditionOrErrorListener listener to add

removeListener

void removeListener(IConditionOrErrorListener listener)

Removes a IConditionOrErrorListener listener

Parameters:

listener - IConditionOrErrorListener listener to remove