org.jitsi.sctp4j

Class SctpSocket

java.lang.Object

org.jitsi.sctp4j.SctpSocket

public class SctpSocket
extends Object

SCTP socket implemented using "usrsctp" lib.

Author:

Pawel Domas, George Politis, Lyubomir Marinov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SctpSocket.NotificationListener Interface used to listen for SCTP notifications on specific socket.

Method Summary

Modifier and Type	Method and Description
boolean	accept() Accepts incoming SCTP connection.
void	close() Closes this socket.
void	connect(int remotePort) Initializes SCTP connection by sending INIT message.
static void	debugSctpPacket(byte[] packet, String id)
int	getPort() Returns SCTP port used by this socket.
void	listen() Makes SCTP socket passive.
void	onConnIn(byte[] packet, int offset, int len) Call this method to pass network packets received on the link.
int	send(byte[] data, boolean ordered, int sid, int ppid) Sends given data on selected SCTP stream using given payload protocol identifier.
int	send(byte[] data, int offset, int len, boolean ordered, int sid, int ppid) Sends given data on selected SCTP stream using given payload protocol identifier.
void	setDataCallback(SctpDataCallback callback) Sets the callback that will be fired when new data is received.
void	setLink(NetworkLink link) Sets the link that will be used to send network packets.
void	setNotificationListener(SctpSocket.NotificationListener l) Sets the listener that will be notified about SCTP event.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

debugSctpPacket

public static void debugSctpPacket(byte[] packet,
                                   String id)

accept

public boolean accept()
               throws IOException

Accepts incoming SCTP connection. FIXME: Usrscp is currently configured to work in non blocking mode thus this method should be polled in intervals.

Returns:

true if we have accepted incoming connection successfully.

Throws:

IOException

close

public void close()

Closes this socket. After call to this method this instance MUST NOT be used.

connect

public void connect(int remotePort)
             throws IOException

Initializes SCTP connection by sending INIT message.

Parameters:

remotePort - remote SCTP port.

Throws:

IOException - if this socket is closed or an error occurs while trying to connect the socket.

getPort

public int getPort()

Returns SCTP port used by this socket.

Returns:

SCTP port used by this socket.

listen

public void listen()
            throws IOException

Makes SCTP socket passive.

Throws:

IOException

onConnIn

public void onConnIn(byte[] packet,
                     int offset,
                     int len)
              throws IOException

Call this method to pass network packets received on the link.

Parameters:

packet - network packet received.

offset - the position in the packet buffer where actual data starts

len - length of packet data in the buffer.

Throws:

IOException

send

public int send(byte[] data,
                boolean ordered,
                int sid,
                int ppid)
         throws IOException

Sends given data on selected SCTP stream using given payload protocol identifier.

Parameters:

data - the data to send.

ordered - should we care about message order ?

sid - SCTP stream identifier

ppid - payload protocol identifier

Returns:

sent bytes count or -1 in case of an error.

Throws:

IOException

send

public int send(byte[] data,
                int offset,
                int len,
                boolean ordered,
                int sid,
                int ppid)
         throws IOException

Sends given data on selected SCTP stream using given payload protocol identifier.

Parameters:

data - the data to send.

offset - position of the data inside the buffer

len - data length

ordered - should we care about message order ?

sid - SCTP stream identifier

ppid - payload protocol identifier

Returns:

sent bytes count or -1 in case of an error.

Throws:

IOException

setDataCallback

public void setDataCallback(SctpDataCallback callback)

Sets the callback that will be fired when new data is received.

Parameters:

callback - the callback that will be fired when new data is received.

setLink

public void setLink(NetworkLink link)

Sets the link that will be used to send network packets.

Parameters:

link - NetworkLink that will be used by this instance to send network packets.

setNotificationListener

public void setNotificationListener(SctpSocket.NotificationListener l)

Sets the listener that will be notified about SCTP event.

Parameters:

l - the SctpSocket.NotificationListener to set.

toString

public String toString()

Overrides:

toString in class Object