org.elastos.carrier.session

Class AbstractStreamHandler

java.lang.Object

org.elastos.carrier.session.AbstractStreamHandler

All Implemented Interfaces:

StreamHandler

public class AbstractStreamHandler
extends java.lang.Object
implements StreamHandler

The abstract carrier stream handler class.

Constructor Summary

Constructors

Constructor and Description
AbstractStreamHandler()

Method Summary

Modifier and Type	Method and Description
void	onChannelClose(Stream stream, int channel, CloseReason reason) The callback function to be called when channel close.
boolean	onChannelData(Stream stream, int channel, byte[] data) The callback functiont to be called when channel received incoming data.
boolean	onChannelOpen(Stream stream, int channel, java.lang.String cookie) The callback function to be called when new multiplexing channel request to open.
void	onChannelOpened(Stream stream, int channel) The callback function to be called when new multiplexing channel opened.
void	onChannelPending(Stream stream, int channel) The callback function to be called when remote peer ask to pend data sending.
void	onChannelResume(Stream stream, int channel) The callback function to be called when remote peer ask to resume data sending.
void	onStateChanged(Stream stream, StreamState state) The callback function to report state of stream when it's state changes.
void	onStreamData(Stream stream, byte[] data) The callback will be called when the stream receives incoming packet.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStreamHandler

public AbstractStreamHandler()

Method Detail

onStateChanged

public void onStateChanged(Stream stream,
                           StreamState state)

The callback function to report state of stream when it's state changes.

Specified by:

onStateChanged in interface StreamHandler

Parameters:

stream - The carrier stream instance

state - Stream state defined in StreamState

onStreamData

public void onStreamData(Stream stream,
                         byte[] data)

The callback will be called when the stream receives incoming packet. If the stream enabled multiplexing mode, application will not receive stream-layered data callback any more. All data will reported as multiplexing channel data.

Specified by:

onStreamData in interface StreamHandler

Parameters:

stream - The carrier stream instance

data - The received packet data

onChannelOpen

public boolean onChannelOpen(Stream stream,
                             int channel,
                             java.lang.String cookie)

The callback function to be called when new multiplexing channel request to open.

Specified by:

onChannelOpen in interface StreamHandler

Parameters:

stream - The carrier stream instance

channel - The current channel ID.

cookie - Application defined string data send from remote peer.

Returns:

True on success, or false if an error occurred. The channel will continue to open only this callback return true, otherwise the channel will be closed.

onChannelOpened

public void onChannelOpened(Stream stream,
                            int channel)

The callback function to be called when new multiplexing channel opened.

Specified by:

onChannelOpened in interface StreamHandler

Parameters:

stream - The carrier stream instance

channel - The current channel ID

onChannelClose

public void onChannelClose(Stream stream,
                           int channel,
                           CloseReason reason)

The callback function to be called when channel close.

Specified by:

onChannelClose in interface StreamHandler

Parameters:

stream - The carrier stream instance

channel - The current channel ID.

reason - Channel close reason code, defined in CloseReason.

onChannelData

public boolean onChannelData(Stream stream,
                             int channel,
                             byte[] data)

The callback functiont to be called when channel received incoming data.

Specified by:

onChannelData in interface StreamHandler

Parameters:

stream - The carrier stream instance

channel - The current channel ID

data - The received data

Returns:

True on success, or false if an error occurred. If this callback return false, the channel will be closed with CloseReason_Error.

onChannelPending

public void onChannelPending(Stream stream,
                             int channel)

The callback function to be called when remote peer ask to pend data sending.

Specified by:

onChannelPending in interface StreamHandler

Parameters:

stream - The carrier stream instance

channel - The current channel ID

onChannelResume

public void onChannelResume(Stream stream,
                            int channel)

The callback function to be called when remote peer ask to resume data sending.

Specified by:

onChannelResume in interface StreamHandler

Parameters:

stream - The carrier stream instance

channel - The current channel ID