Package org.mases.datadistributionmanager

Class SmartDataDistributionChannel

java.lang.Object

org.mases.datadistributionmanager.SmartDataDistributionChannel

All Implemented Interfaces:

ISmartDataDistributionChannel, ISmartDataDistributionChannelInfo

public class SmartDataDistributionChannel
extends java.lang.Object
implements ISmartDataDistributionChannel

Main class managing channel

Field Summary

Fields

Modifier and Type	Field	Description
long	DDM_NO_TIMESTAMP	No timestamp value

Constructor Summary

Constructors

Constructor	Description
SmartDataDistributionChannel()	Ctor

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	getChannelName()	The name of the channel
long	getOffset()	The last available message offset associated to the data
java.lang.String	GetParameter(java.lang.String paramName)	Get parameter from channel
java.lang.String	GetParameter(DDM_GENERAL_PARAMETER paramId)	Get parameter from channel
long	getTimestamp()	The last available message timestamp associated to the data
OPERATION_RESULT	Lock(int timeout)	Locks the channel
void	OnConditionOrError(OPERATION_RESULT errorCode, int nativeCode, java.lang.String subSystemReason)	Called when an event condition is raised from subsystem
void	OnDataAvailable(java.lang.String key, byte[] buffer)	Called when a data is available
void	OnUnderlyingEvent(long opaque, long channelHandle, java.lang.String topicName, int condition, boolean isDataAvailable, java.lang.String key, byte[] buffer, int nativeCode, java.lang.String subSystemReason, long timestamp, long offset)
void	OnUnderlyingEvent(long opaque, long channelHandle, UnderlyingEvent uEvent)
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 class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DDM_NO_TIMESTAMP

public final long DDM_NO_TIMESTAMP

No timestamp value

See Also:

Constant Field Values

Constructor Detail

SmartDataDistributionChannel

public SmartDataDistributionChannel()

Ctor

Method Detail

StartChannel

public OPERATION_RESULT StartChannel(int timeout)

Description copied from interface: ISmartDataDistributionChannel

Starts the channel

Specified by:

StartChannel in interface ISmartDataDistributionChannel

Parameters:

timeout - Timeout in ms

Returns:

OPERATION_RESULT

StopChannel

public OPERATION_RESULT StopChannel(int timeout)

Description copied from interface: ISmartDataDistributionChannel

Stops the channel

Specified by:

StopChannel in interface ISmartDataDistributionChannel

Parameters:

timeout - Timeout in ms

Returns:

OPERATION_RESULT

SetParameter

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

Description copied from interface: ISmartDataDistributionChannel

Set parameter on channel

Specified by:

SetParameter in interface ISmartDataDistributionChannel

Parameters:

paramName - Parameter name to set

paramValue - Parameter value to set

SetParameter

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

Description copied from interface: ISmartDataDistributionChannel

Set parameter on channel

Specified by:

SetParameter in interface ISmartDataDistributionChannel

Parameters:

paramId - Parameter DDM_GENERAL_PARAMETER to set

paramValue - Parameter value to set

GetParameter

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

Description copied from interface: ISmartDataDistributionChannel

Get parameter from channel

Specified by:

GetParameter in interface ISmartDataDistributionChannel

Parameters:

paramName - Parameter name to get

Returns:

Parameter value

GetParameter

public java.lang.String GetParameter(DDM_GENERAL_PARAMETER paramId)

Description copied from interface: ISmartDataDistributionChannel

Get parameter from channel

Specified by:

GetParameter in interface ISmartDataDistributionChannel

Parameters:

paramId - Parameter DDM_GENERAL_PARAMETER to get

Returns:

Parameter value

Lock

public OPERATION_RESULT Lock(int timeout)

Description copied from interface: ISmartDataDistributionChannel

Locks the channel

Specified by:

Lock in interface ISmartDataDistributionChannel

Parameters:

timeout - Timeout in ms

Returns:

OPERATION_RESULT

Unlock

public OPERATION_RESULT Unlock()

Description copied from interface: ISmartDataDistributionChannel

Unlocks the channel

Specified by:

Unlock in interface ISmartDataDistributionChannel

Returns:

OPERATION_RESULT

SeekChannel

public OPERATION_RESULT SeekChannel(long position)

Description copied from interface: ISmartDataDistributionChannel

Seek the channel using absolute offset

Specified by:

SeekChannel in interface ISmartDataDistributionChannel

Parameters:

position - Seek offset poisition

Returns:

OPERATION_RESULT

SeekChannel

public OPERATION_RESULT SeekChannel(long position,
                                    DDM_SEEKKIND kind)

Description copied from interface: ISmartDataDistributionChannel

Seek the channel using absolute or relative offset

Specified by:

SeekChannel in interface ISmartDataDistributionChannel

Parameters:

position - Seek offset poisition

kind - DDM_SEEKKIND to use

Returns:

OPERATION_RESULT

SeekChannel

public OPERATION_RESULT SeekChannel(java.util.Date position)

Description copied from interface: ISmartDataDistributionChannel

Seek the channel to an absolute timestamp

Specified by:

SeekChannel in interface ISmartDataDistributionChannel

Parameters:

position - Seek timestamp to an absolute poisition

Returns:

OPERATION_RESULT

SeekChannel

public OPERATION_RESULT SeekChannel(java.time.Duration position)

Description copied from interface: ISmartDataDistributionChannel

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

Specified by:

SeekChannel in interface ISmartDataDistributionChannel

Parameters:

position - Seek timestamp relative poisition

Returns:

OPERATION_RESULT

SeekChannel

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

Description copied from interface: ISmartDataDistributionChannel

Seek the channel using absolute or relative offset

Specified by:

SeekChannel in interface ISmartDataDistributionChannel

Parameters:

position - Seek offset poisition

context - DDM_SEEKCONTEXT to use

kind - DDM_SEEKKIND to use

Returns:

OPERATION_RESULT

WriteOnChannel

public OPERATION_RESULT WriteOnChannel(java.lang.String value)

Description copied from interface: ISmartDataDistributionChannel

Writes on the channel

Specified by:

WriteOnChannel in interface ISmartDataDistributionChannel

Parameters:

value - The String to write in the channel

Returns:

OPERATION_RESULT

WriteOnChannel

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

Description copied from interface: ISmartDataDistributionChannel

Writes on the channel

Specified by:

WriteOnChannel in interface ISmartDataDistributionChannel

Parameters:

key - The key to use

value - The String to write in the channel

Returns:

OPERATION_RESULT

WriteOnChannel

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

Description copied from interface: ISmartDataDistributionChannel

Writes on the channel

Specified by:

WriteOnChannel in interface ISmartDataDistributionChannel

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

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

Description copied from interface: ISmartDataDistributionChannel

Writes on the channel

Specified by:

WriteOnChannel in interface ISmartDataDistributionChannel

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

public OPERATION_RESULT WriteOnChannel(byte[] buffer)

Description copied from interface: ISmartDataDistributionChannel

Writes on the channel

Specified by:

WriteOnChannel in interface ISmartDataDistributionChannel

Parameters:

buffer - The buffer to write in the channel

Returns:

OPERATION_RESULT

WriteOnChannel

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

Description copied from interface: ISmartDataDistributionChannel

Writes on the channel

Specified by:

WriteOnChannel in interface ISmartDataDistributionChannel

Parameters:

key - The key to use

buffer - The buffer to write in the channel

Returns:

OPERATION_RESULT

WriteOnChannel

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

Description copied from interface: ISmartDataDistributionChannel

Writes on the channel

Specified by:

WriteOnChannel in interface ISmartDataDistributionChannel

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

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

Description copied from interface: ISmartDataDistributionChannel

Writes on the channel

Specified by:

WriteOnChannel in interface ISmartDataDistributionChannel

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

public byte[] ReadFromChannel(long offset,
                              long length)

Description copied from interface: ISmartDataDistributionChannel

Reads from the channel

Specified by:

ReadFromChannel in interface ISmartDataDistributionChannel

Parameters:

offset - offset in the stream

length - number of elements

Returns:

an array of byte

ChangeDirectionOnChannel

public OPERATION_RESULT ChangeDirectionOnChannel(DDM_CHANNEL_DIRECTION direction)

Description copied from interface: ISmartDataDistributionChannel

Change direction of the channel

Specified by:

ChangeDirectionOnChannel in interface ISmartDataDistributionChannel

Parameters:

direction - DDM_CHANNEL_DIRECTION

Returns:

OPERATION_RESULT

addListener

public void addListener(IDataAvailableListener listener)

Description copied from interface: ISmartDataDistributionChannel

Adds a IDataAvailableListener listener

Specified by:

addListener in interface ISmartDataDistributionChannel

Parameters:

listener - IDataAvailableListener listener to add

removeListener

public void removeListener(IDataAvailableListener listener)

Description copied from interface: ISmartDataDistributionChannel

Removes a IDataAvailableListener listener

Specified by:

removeListener in interface ISmartDataDistributionChannel

Parameters:

listener - IDataAvailableListener listener to remove

OnDataAvailable

public void OnDataAvailable(java.lang.String key,
                            byte[] buffer)

Called when a data is available

Parameters:

key - Message key

buffer - Message buffer

addListener

public void addListener(IConditionOrErrorListener listener)

Description copied from interface: ISmartDataDistributionChannel

Adds a IConditionOrErrorListener listener

Specified by:

addListener in interface ISmartDataDistributionChannel

Parameters:

listener - IConditionOrErrorListener listener to add

removeListener

public void removeListener(IConditionOrErrorListener listener)

Description copied from interface: ISmartDataDistributionChannel

Removes a IConditionOrErrorListener listener

Specified by:

removeListener in interface ISmartDataDistributionChannel

Parameters:

listener - IConditionOrErrorListener listener to remove

OnConditionOrError

public void OnConditionOrError(OPERATION_RESULT errorCode,
                               int nativeCode,
                               java.lang.String subSystemReason)

Called when an event condition is raised from subsystem

Parameters:

errorCode - The error code reported

nativeCode - The native code associated to the error if available

subSystemReason - A String with a reason from subsystem

getChannelName

public java.lang.String getChannelName()

Description copied from interface: ISmartDataDistributionChannelInfo

The name of the channel

Specified by:

getChannelName in interface ISmartDataDistributionChannelInfo

Returns:

The name of the channel

getTimestamp

public long getTimestamp()

Description copied from interface: ISmartDataDistributionChannelInfo

The last available message timestamp associated to the data

Specified by:

getTimestamp in interface ISmartDataDistributionChannelInfo

Returns:

The last available message timestamp associated to the data: Milliseconds since epoch (UTC).

getOffset

public long getOffset()

Description copied from interface: ISmartDataDistributionChannelInfo

The last available message offset associated to the data

Specified by:

getOffset in interface ISmartDataDistributionChannelInfo

Returns:

The last available message offset associated to the data

OnUnderlyingEvent

public void OnUnderlyingEvent(long opaque,
                              long channelHandle,
                              UnderlyingEvent uEvent)

OnUnderlyingEvent

public final void OnUnderlyingEvent(long opaque,
                                    long channelHandle,
                                    java.lang.String topicName,
                                    int condition,
                                    boolean isDataAvailable,
                                    java.lang.String key,
                                    byte[] buffer,
                                    int nativeCode,
                                    java.lang.String subSystemReason,
                                    long timestamp,
                                    long offset)