info.pppc.base.system.plugin

Interface ITransceiver

All Superinterfaces:

IExtension, IPlugin, IStreamer

All Known Implementing Classes:

IPBroadcastTransceiver, IPMulticastTransceiver, MxIPBroadcastTransceiver, MxIPMulticastTransceiver

public interface ITransceiver
extends IPlugin, IStreamer

A communication transceiver describes a plug-in that can receive and transmit data to a remote system. A communication transceiver is either enabled, i.e. it can send and receive data or it is disabled. If it is disabled, it should release all handles to the communication card it is associated with, since BASE might decide to disable the card which will typically be invisible to the plug-in.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_TRANCEIVER_DISABLED An event type constant that signals that the transceiver has been disabled.
static int	EVENT_TRANCEIVER_ENABLED An event type constant that signals that the transceiver has been enabled.

Fields inherited from interface info.pppc.base.system.IExtension

EXTENSION_COMPRESSION, EXTENSION_DISCOVERY, EXTENSION_ENCRYPTION, EXTENSION_ROUTING, EXTENSION_SEMANTIC, EXTENSION_SERIALIZATION, EXTENSION_TRANSCEIVER

Method Summary

Methods

Modifier and Type	Method and Description
void	addTransceiverListener(int type, IListener listener) Adds a listener to the transceiver that signals changes to the state of the transceiver.
boolean	isEnabled() Determines whether this communication transceiver is enabled.
IPacketConnector	openGroup() Opens an outgoing or incoming packet based connector that exchanges packets with other devices using broadcast semantics.
boolean	removeTransceiverListener(int type, IListener listener) Removes the specified listener for the specified set of event types.
void	setEnabled(boolean enabled) Enables or disables this communication transceiver.
void	setTransceiverManager(ITransceiverManager manager) Sets the plug-in manager of this plug-in.

Methods inherited from interface info.pppc.base.system.plugin.IPlugin

getPluginDescription, start, stop

Methods inherited from interface info.pppc.base.system.plugin.IStreamer

openSession, prepareSession

Field Detail

EVENT_TRANCEIVER_ENABLED

static final int EVENT_TRANCEIVER_ENABLED

An event type constant that signals that the transceiver has been enabled. The data object of this event will be null.

See Also:

Constant Field Values

EVENT_TRANCEIVER_DISABLED

static final int EVENT_TRANCEIVER_DISABLED

An event type constant that signals that the transceiver has been disabled. The data object of this event will be null.

See Also:

Constant Field Values

Method Detail

setTransceiverManager

void setTransceiverManager(ITransceiverManager manager)

Sets the plug-in manager of this plug-in. The plug-in manager enables a plug-in to request a communication stack and to perform operations. This method is guaranteed to be called before the start method is invoked the first time.

Parameters:

manager - The manager of the plug-in.

addTransceiverListener

void addTransceiverListener(int type,
                          IListener listener)

Adds a listener to the transceiver that signals changes to the state of the transceiver. When the transceiver is enabled, the transceiver will fire an EVENT_TRANCEIVER_ENABLED event. If it is disabled, an EVENT_TRANCEIVER_DISABLED event will be fired. The data object of these events is null.

Parameters:

type - The type of event to register for. At the present time the transceiver must support EVENT_TRANCEIVER_ENABLED and EVENT_TRANCEIVER_DISABLED events.

listener - The listener to register for the specified events.

Throws:

java.lang.NullPointerException - Thrown if the listener that is registered is null.

removeTransceiverListener

boolean removeTransceiverListener(int type,
                                IListener listener)

Removes the specified listener for the specified set of event types.

Parameters:

type - The types of events to unregister.

listener - The listener to unregister for the specified types of events.

Returns:

True if the listener is no longer registered for any event, false if the listener is still registered or if it has not been registered.

Throws:

java.lang.NullPointerException - Thrown if the listener that should be unregistered is null.

setEnabled

void setEnabled(boolean enabled)

Enables or disables this communication transceiver.

Parameters:

enabled - True to enable the communication transceiver, false to disable.

isEnabled

boolean isEnabled()

Determines whether this communication transceiver is enabled.

Returns:

True if it is enabled, false if it is disabled.

openGroup

IPacketConnector openGroup()
                           throws java.io.IOException

Opens an outgoing or incoming packet based connector that exchanges packets with other devices using broadcast semantics.

Returns:

The connector that is capable of exchanging packets or null if such a connector cannot be created.

Throws:

java.io.IOException - Thrown if the connector cannot be opened.