|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface represents the operations available for all BEEP Channels.
Field Summary | |
static int |
STATE_ABORTED
|
static int |
STATE_ACTIVE
|
static int |
STATE_CLOSE_PENDING
|
static int |
STATE_CLOSED
|
static int |
STATE_CLOSING
|
static int |
STATE_INITIALIZED
|
static int |
STATE_STARTING
|
static int |
STATE_TUNING
|
static int |
STATE_TUNING_PENDING
|
Method Summary | |
void |
close()
Closes the channel. |
java.lang.Object |
getAppData()
Returns application context data previously set using setAppData() . |
MessageListener |
getMessageListener()
Deprecated. |
int |
getNumber()
Return the number of this Channel . |
java.lang.String |
getProfile()
|
RequestHandler |
getRequestHandler()
Returns the RequestHandler registered with this channel. |
Session |
getSession()
Returns the session for this channel. |
java.lang.String |
getStartData()
Deprecated. |
int |
getState()
Returns the state of this channel. |
MessageStatus |
sendMSG(OutputDataStream stream,
ReplyListener replyListener)
Sends a MSG message. |
void |
setAppData(java.lang.Object applicationData)
Set the application context data. |
MessageListener |
setMessageListener(MessageListener listener)
Deprecated. |
RequestHandler |
setRequestHandler(RequestHandler handler)
Sets the MSG handler for this Channel . |
RequestHandler |
setRequestHandler(RequestHandler handler,
boolean tuningReset)
Sets the MSG handler for this Channel . |
void |
setStartData(java.lang.String data)
Deprecated. |
Field Detail |
public static final int STATE_INITIALIZED
public static final int STATE_STARTING
public static final int STATE_ACTIVE
public static final int STATE_TUNING_PENDING
public static final int STATE_TUNING
public static final int STATE_CLOSE_PENDING
public static final int STATE_CLOSING
public static final int STATE_CLOSED
public static final int STATE_ABORTED
Method Detail |
public void close() throws BEEPException
BEEPException
public java.lang.Object getAppData()
setAppData()
.
setAppData(java.lang.Object)
public void setAppData(java.lang.Object applicationData)
getAppData()
public int getNumber()
Channel
.
public MessageListener setMessageListener(MessageListener listener)
MessageListener
for this channel.
listener
-
public MessageListener getMessageListener()
public RequestHandler getRequestHandler()
RequestHandler
registered with this channel.
public RequestHandler setRequestHandler(RequestHandler handler)
Channel
.
handler
- RequestHandler
to handle received
MSG messages.
RequestHandler
or null
if
one wasn't set.public RequestHandler setRequestHandler(RequestHandler handler, boolean tuningReset)
Channel
.
handler
- RequestHandler
to handle received
MSG messages.tuningReset
- flag indicating that the profile will request a
tuning reset.
RequestHandler
or null
if
one wasn't set.public Session getSession()
public int getState()
public MessageStatus sendMSG(OutputDataStream stream, ReplyListener replyListener) throws BEEPException
stream
- Data contents of the MSG message to be sent.replyListener
- A listener to be notified when a reply to this
MSG is received.
BEEPException
- if an error is encoutered.OutputDataStream
,
MessageStatus
public void setStartData(java.lang.String data)
public java.lang.String getStartData()
public java.lang.String getProfile()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |