org.objectweb.dream
Interface Push

All Known Subinterfaces:

PushWithReturn

All Known Implementing Classes:

PushToPush1Impl

public interface Push

Common Push interface for Dream components This interface defines a method push that allows a component to give a message to another component.

Field Summary

static String	IN_PUSH_ITF_NAME The commonly used name to refer to this interface when it is used as an input.
static String	INCOMING_IN_PUSH_ITF_NAME The commonly used name to refer to this interface when it is used as an input for incoming messages.
static String	INCOMING_OUT_PUSH_ITF_NAME The commonly used name to refer to this interface when it is used as an output for incoming messages.
static String	OUT_PUSH_ITF_NAME The commonly used name to refer to this interface when it is used as an output.
static String	OUTGOING_IN_PUSH_ITF_NAME The commonly used name to refer to this interface when it is used as an input for outgoing messages.
static String	OUTGOING_OUT_PUSH_ITF_NAME The commonly used name to refer to this interface when it is used as an output for outgoing messages.

Method Summary

void	push(Message message) Gives a message to a component.

Field Detail

OUT_PUSH_ITF_NAME

static final String OUT_PUSH_ITF_NAME

The commonly used name to refer to this interface when it is used as an output.

See Also:

Constant Field Values

IN_PUSH_ITF_NAME

static final String IN_PUSH_ITF_NAME

The commonly used name to refer to this interface when it is used as an input.

See Also:

Constant Field Values

OUTGOING_IN_PUSH_ITF_NAME

static final String OUTGOING_IN_PUSH_ITF_NAME

The commonly used name to refer to this interface when it is used as an input for outgoing messages.

See Also:

Constant Field Values

OUTGOING_OUT_PUSH_ITF_NAME

static final String OUTGOING_OUT_PUSH_ITF_NAME

The commonly used name to refer to this interface when it is used as an output for outgoing messages.

See Also:

Constant Field Values

INCOMING_IN_PUSH_ITF_NAME

static final String INCOMING_IN_PUSH_ITF_NAME

The commonly used name to refer to this interface when it is used as an input for incoming messages.

See Also:

Constant Field Values

INCOMING_OUT_PUSH_ITF_NAME

static final String INCOMING_OUT_PUSH_ITF_NAME

The commonly used name to refer to this interface when it is used as an output for incoming messages.

See Also:

Constant Field Values

Method Detail

push

void push(Message message)
          throws PushException

Gives a message to a component.

Parameters:

message - the message to give to the component.

Throws:

PushException - if an exception occurs.