org.elastos.carrier.session

Class Session

java.lang.Object

org.elastos.carrier.session.Session

public class Session
extends java.lang.Object

The class representing Carrier session conversion with friends.

Method Summary

Modifier and Type	Method and Description
void	addService(java.lang.String service, PortForwardingProtocol protocol, java.lang.String host, java.lang.String port) Add a new portforwarding service to session.
Stream	addStream(StreamType type, int options, StreamHandler handler) Add a new stream to session.
void	close() Close a session to friend.
protected void	finalize()
java.lang.String	getPeer() Get remote peer id.
void	removeService(java.lang.String service) Remove a portforwarding server to session.
void	removeStream(Stream stream) Remove a stream from session.
void	replyRequest(int status, java.lang.String reason) Reply the session request from friend.
void	request(SessionRequestCompleteHandler handler) Send session request to the friend.
void	start(java.lang.String sdp) Begin to start a session.

Methods inherited from class java.lang.Object

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

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

close

public void close()

Close a session to friend. All resources include streams, channels, portforwardings associated with current session will be destroyed.

getPeer

public java.lang.String getPeer()

Get remote peer id.

Returns:

The remote peer userid.

request

public void request(SessionRequestCompleteHandler handler)
             throws CarrierException

Send session request to the friend.

Parameters:

handler - A handler to the SessionRequestCompleteHandler to receive the session response

Throws:

java.lang.IllegalArgumentException - CarrierException

CarrierException

replyRequest

public void replyRequest(int status,
                         java.lang.String reason)
                  throws CarrierException

Reply the session request from friend. This function will send a session response to friend.

Parameters:

status - The status code of the response. 0 is success, otherwise is error

reason - The error message if status is error, or null if success

Throws:

java.lang.IllegalArgumentException - CarrierException

CarrierException

start

public void start(java.lang.String sdp)
           throws CarrierException

Begin to start a session. All streams in current session will try to connect with remote friend, The stream status will update to application by stream's StreamHandler.

Parameters:

sdp - The remote user's SDP. Reference: https://tools.ietf.org/html/rfc4566

Throws:

java.lang.IllegalArgumentException - CarrierException

CarrierException

addStream

public Stream addStream(StreamType type,
                        int options,
                        StreamHandler handler)
                 throws CarrierException

Add a new stream to session. Carrier stream supports several underlying transport mechanisms: - Plain/encrypted UDP data gram protocol - Plain/encrypted TCP like reliable stream protocol - Multiplexing over UDP - Multiplexing over TCP like reliable protocol Application can use options to specify the new stream mode. Multiplexing over UDP can not provide reliable transport.

Parameters:

type - The stream type defined in StreamType

options - The stream mode options. options are constructed by a bitwise-inclusive OR of flags

handler - The Application defined inerface to StreamHandler

Returns:

The new added carrier stream

Throws:

java.lang.IllegalArgumentException - CarrierException

CarrierException

removeStream

public void removeStream(Stream stream)
                  throws CarrierException

Remove a stream from session.

Parameters:

stream - The Stream to be removed

Throws:

java.lang.IllegalArgumentException - CarrierException

CarrierException

addService

public void addService(java.lang.String service,
                       PortForwardingProtocol protocol,
                       java.lang.String host,
                       java.lang.String port)
                throws CarrierException

Add a new portforwarding service to session. The registered services can be used by remote peer in portforwarding request.

Parameters:

service - The new service name, should be unique in session scope

protocol - The protocol of the service

host - The host name or ip of the service

port - The port of the service

Throws:

java.lang.IllegalArgumentException - CarrierException

CarrierException

removeService

public void removeService(java.lang.String service)

Remove a portforwarding server to session. This function has not effect on existing portforwarings.

Parameters:

service - The service name.