org.elastos.carrier.session

Class Stream

java.lang.Object

org.elastos.carrier.session.Stream

public class Stream
extends java.lang.Object

The class representing Carrier stream.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROPERTY_COMPRESS
static int	PROPERTY_MULTIPLEXING
static int	PROPERTY_PLAIN
static int	PROPERTY_PORT_FORWARDING
static int	PROPERTY_RELIABLE

Method Summary

Modifier and Type	Method and Description
void	closeChannel(int channel) Close a new channel on multiplexing stream.
void	closePortForwarding(int portForwarding) Close a port forwarding.
java.io.OutputStream	getOutputStream()
java.io.OutputStream	getOutputStream(int channel)
int	getStreamId()
TransportInfo	getTransportInfo() Get tranport info of carrier stream.
StreamType	getType() Get the carrier stream type.
int	openChannel(java.lang.String cookie) Open a new channel on multiplexing stream.
int	openPortForwarding(java.lang.String service, PortForwardingProtocol protocol, java.lang.String host, java.lang.String port) Open a port forwarding to remote service over multiplexing.
void	pendChannel(int channel) Request remote peer to pend channel data sending.
void	resumeChannel(int channel) Request remote peer to resume channel data sending.
int	writeData(byte data) Send outgoing data to remote peer.
int	writeData(byte[] data) Send outgoing data to remote peer.
int	writeData(byte[] data, int offset, int len) Send outgoing data to remote peer.
int	writeData(int channel, byte data) Send outgoing data to remote peer.
int	writeData(int channel, byte[] data) Send outgoing data to remote peer.
int	writeData(int channel, byte[] data, int offset, int len) Send outgoing data to remote peer.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_COMPRESS

public static int PROPERTY_COMPRESS

PROPERTY_PLAIN

public static int PROPERTY_PLAIN

PROPERTY_RELIABLE

public static int PROPERTY_RELIABLE

PROPERTY_MULTIPLEXING

public static int PROPERTY_MULTIPLEXING

PROPERTY_PORT_FORWARDING

public static int PROPERTY_PORT_FORWARDING

Method Detail

getStreamId

public int getStreamId()

getType

public StreamType getType()

Get the carrier stream type.

Returns:

The stream type defined in StreamType.

getTransportInfo

public TransportInfo getTransportInfo()
                               throws CarrierException

Get tranport info of carrier stream.

Returns:

The transport info of this stream.

Throws:

CarrierException

writeData

public int writeData(byte[] data,
                     int offset,
                     int len)
              throws CarrierException

Send outgoing data to remote peer. If the stream is in multiplexing mode, application can not call this function to send data. If this function is called on multiplexing mode stream, it will throw exception.

Parameters:

data - The outgoing data offset The start offset len The bytes to write

Returns:

Bytes of data sent on success

Throws:

CarrierException

writeData

public int writeData(byte[] data)
              throws CarrierException

Send outgoing data to remote peer. If the stream is in multiplexing mode, application can not call this function to send data. If this function is called on multiplexing mode stream, it will throw exception.

Parameters:

data - The outgoing data

Returns:

Bytes of data sent on success

Throws:

CarrierException

writeData

public int writeData(byte data)
              throws CarrierException

Send outgoing data to remote peer. If the stream is in multiplexing mode, application can not call this function to send data. If this function is called on multiplexing mode stream, it will throw exception.

Parameters:

data - The outgoing data

Returns:

Bytes of data sent on success

Throws:

CarrierException

getOutputStream

public java.io.OutputStream getOutputStream()

getOutputStream

public java.io.OutputStream getOutputStream(int channel)

openChannel

public int openChannel(java.lang.String cookie)
                throws CarrierException

Open a new channel on multiplexing stream. If the stream is not multiplexing this function will throw exception.

Parameters:

cookie - The application defined data passed to remote peer

Returns:

New channel ID

Throws:

CarrierException

closeChannel

public void closeChannel(int channel)
                  throws CarrierException

Close a new channel on multiplexing stream. If the stream is not multiplexing this function will throw exception.

Parameters:

channel - The channel ID to close

Throws:

CarrierException

writeData

public int writeData(int channel,
                     byte[] data,
                     int offset,
                     int len)
              throws CarrierException

Send outgoing data to remote peer. If the stream is not multiplexing this function will throw exception.

Parameters:

channel - [in] The channel ID

data - [in] The outgoing data offset [in] The start offset len [in] The bytes to write

Returns:

Bytes of data sent on success.

Throws:

CarrierException

writeData

public int writeData(int channel,
                     byte[] data)
              throws CarrierException

Send outgoing data to remote peer. If the stream is not multiplexing this function will throw exception.

Parameters:

channel - [in] The channel ID

data - [in] The outgoing data

Returns:

Bytes of data sent on success.

Throws:

CarrierException

writeData

public int writeData(int channel,
                     byte data)
              throws CarrierException

Send outgoing data to remote peer. If the stream is not multiplexing this function will throw exception.

Parameters:

channel - [in] The channel ID

data - [in] The outgoing data

Returns:

Bytes of data sent on success.

Throws:

CarrierException

pendChannel

public void pendChannel(int channel)
                 throws CarrierException

Request remote peer to pend channel data sending. If the stream is not multiplexing this function will throw exception.

Parameters:

channel - The channel ID

Throws:

CarrierException

resumeChannel

public void resumeChannel(int channel)
                   throws CarrierException

Request remote peer to resume channel data sending. If the stream is not multiplexing this function will throw exception.

Parameters:

channel - The channel ID

Throws:

CarrierException

openPortForwarding

public int openPortForwarding(java.lang.String service,
                              PortForwardingProtocol protocol,
                              java.lang.String host,
                              java.lang.String port)
                       throws CarrierException

Open a port forwarding to remote service over multiplexing. If the stream is not multiplexing this function will throw exception.

Parameters:

service - The remote service name

protocol - Port forwarding protocol

host - Local host or ip to binding If host is null, port forwarding will bind to localhost

port - Local port to binding, can not be nil.

Returns:

Port forwarding ID

Throws:

CarrierException

closePortForwarding

public void closePortForwarding(int portForwarding)
                         throws CarrierException

Close a port forwarding. If the stream is not multiplexing this function will throw exception.

Parameters:

portForwarding - The portforwarding ID.

Throws:

CarrierException