org.eclipse.soda.dk.multiplex.connection.service
Interface ChannelService

public interface ChannelService

Since:

1.2

Version:

1.2.0

Field Summary

static int	ACTIVE The ACTIVE state is when the channel is attempting to start but is not yet started.
static int	ALIVE The ALIVE state is when the channel has been told to start and is trying to connect.
static int	CONNECTED The CONNECTED state is when the channel has successfully made the connection and is ready to send and receive messages.
static int	CREATED The CREATED state is when the channel has been created or stopped.
static int	DEAD The DEAD state is when the channel has exited and can not be restarted.
static int	STARTED The STARTED state is when the channel has started and should be processing messages.

Method Summary

void	close() Close.
void	exit() Exit.
java.util.Map	getChannelData() Gets the channel data (Map) value.
java.lang.String	getExternalId() Gets the external ID (String) value.
java.lang.String	getId() Gets the ID (String) value.
int	getState() Gets the state (int) value.
boolean	isReconnectable() Gets the reconnectable (boolean) value.
void	open() Sets the id value.
void	setExternalId(java.lang.String externalId) Sets the external ID value.
void	setState(int newState) Sets the state value.
void	start() Start.
void	stop() Stop.

Field Detail

DEAD

static final int DEAD

The DEAD state is when the channel has exited and can not be restarted.

See Also:

Constant Field Values

CREATED

static final int CREATED

The CREATED state is when the channel has been created or stopped. The channel will not attempt to move to another state until a start request has been issued.

See Also:

Constant Field Values

ALIVE

static final int ALIVE

The ALIVE state is when the channel has been told to start and is trying to connect.

See Also:

Constant Field Values

CONNECTED

static final int CONNECTED

The CONNECTED state is when the channel has successfully made the connection and is ready to send and receive messages.

See Also:

Constant Field Values

ACTIVE

static final int ACTIVE

The ACTIVE state is when the channel is attempting to start but is not yet started.

See Also:

Constant Field Values

STARTED

static final int STARTED

The STARTED state is when the channel has started and should be processing messages.

See Also:

Constant Field Values

Method Detail

close

void close()

Close.

exit

void exit()

Exit.

getChannelData

java.util.Map getChannelData()

Gets the channel data (Map) value.

Returns:

The channel data (Map) value.

getExternalId

java.lang.String getExternalId()

Gets the external ID (String) value.

Returns:

The external id (String) value.

See Also:

setExternalId(String)

getId

java.lang.String getId()

Gets the ID (String) value.

Returns:

The id (Object) value.

See Also:

getExternalId(), setExternalId(String)

getState

int getState()

Gets the state (int) value.

Returns:

The state (int) value.

See Also:

setState(int)

isReconnectable

boolean isReconnectable()

Gets the reconnectable (boolean) value.

Returns:

The reconnectable (boolean) value.

open

void open()

Sets the id value.

setExternalId

void setExternalId(java.lang.String externalId)

Sets the external ID value.

Parameters:

externalId - The external ID (String) parameter.

See Also:

getExternalId()

setState

void setState(int newState)

Sets the state value.

Parameters:

newState - The new state (int) parameter.

See Also:

getState()

start

void start()

Start.

stop

void stop()

Stop.