gov.nist.javax.sip.stack

Class NioTcpMessageChannel

java.lang.Object

gov.nist.javax.sip.stack.MessageChannel

gov.nist.javax.sip.stack.ConnectionOrientedMessageChannel

gov.nist.javax.sip.stack.NioTcpMessageChannel

All Implemented Interfaces:

ParseExceptionListener, SIPMessageListener, RawMessageChannel, Runnable

Direct Known Subclasses:

NioTlsMessageChannel, NioWebSocketMessageChannel

public class NioTcpMessageChannel
extends ConnectionOrientedMessageChannel

Field Summary

Fields

Modifier and Type	Field and Description
protected long	lastActivityTimeStamp
protected SocketChannel	socketChannel

Fields inherited from class gov.nist.javax.sip.stack.ConnectionOrientedMessageChannel

isCached, isRunning, key, myAddress, myClientInputStream, myParser, myPort, mySock, mythread, peerAddress, peerAddressAdvertisedInHeaders, peerPort, peerPortAdvertisedInHeaders, peerProtocol, sipStack

Fields inherited from class gov.nist.javax.sip.stack.MessageChannel

messageProcessor, useCount

Constructor Summary

Constructors

Modifier	Constructor and Description
	NioTcpMessageChannel(InetAddress inetAddress, int port, SIPTransactionStack sipStack, NioTcpMessageProcessor nioTcpMessageProcessor)
protected	NioTcpMessageChannel(NioTcpMessageProcessor nioTcpMessageProcessor, SocketChannel socketChannel)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBytes(byte[] bytes)
protected void	close(boolean removeSocket, boolean stopKeepAliveTask)
boolean	equals(Object other) Equals predicate.
long	getLastActivityTimestamp()
SocketChannel	getSocketChannel()
String	getTransport() get the transport string.
void	handleException(ParseException ex, SIPMessage sipMessage, Class hdrClass, String header, String message) Exception processor for exceptions detected from the parser.
boolean	isSecure() TCP Is not a secure protocol.
void	onNewSocket(byte[] message)
void	readChannel()
protected void	sendMessage(byte[] msg, boolean isClient) Send message to whoever is connected to us.
void	sendMessage(byte[] message, InetAddress receiverAddress, int receiverPort, boolean retry) Send a message to a specified address.
void	sendTCPMessage(byte[] message, InetAddress receiverAddress, int receiverPort, boolean retry) Send a message to a specified address.
void	triggerConnectFailure(Queue<NioTcpMessageProcessor.PendingData> failedMsgs)
void	triggerConnectSuccess()

Methods inherited from class gov.nist.javax.sip.stack.ConnectionOrientedMessageChannel

cancelPingKeepAliveTimeoutTaskIfStarted, close, getKeepAliveTimeout, getKey, getPeerAddress, getPeerInetAddress, getPeerPacketSourceAddress, getPeerPacketSourcePort, getPeerPort, getPeerProtocol, getSIPStack, getViaHost, getViaPort, isReliable, processMessage, processMessage, rescheduleKeepAliveTimeout, run, sendMessage, sendSingleCLRF, setKeepAliveTimeout, uncache

Methods inherited from class gov.nist.javax.sip.stack.MessageChannel

createBadReqRes, getEncapsulatedClientTransaction, getHost, getHostPort, getKey, getKey, getMessageProcessor, getPeerHostPort, getPort, getRawIpSourceAddress, getViaHeader, getViaHostPort, logMessage, logResponse, sendMessage, sendMessage, setEncapsulatedClientTransaction

Methods inherited from class java.lang.Object

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

Field Detail

socketChannel

protected SocketChannel socketChannel

lastActivityTimeStamp

protected long lastActivityTimeStamp

Constructor Detail

NioTcpMessageChannel

protected NioTcpMessageChannel(NioTcpMessageProcessor nioTcpMessageProcessor,
                    SocketChannel socketChannel)
                        throws IOException

Throws:

IOException

NioTcpMessageChannel

public NioTcpMessageChannel(InetAddress inetAddress,
                    int port,
                    SIPTransactionStack sipStack,
                    NioTcpMessageProcessor nioTcpMessageProcessor)
                     throws IOException

Throws:

IOException

Method Detail

readChannel

public void readChannel()

addBytes

protected void addBytes(byte[] bytes)
                 throws Exception

Throws:

Exception

getSocketChannel

public SocketChannel getSocketChannel()

close

protected void close(boolean removeSocket,
         boolean stopKeepAliveTask)

Specified by:

close in class ConnectionOrientedMessageChannel

getTransport

public String getTransport()

get the transport string.

Specified by:

getTransport in class MessageChannel

Returns:

"tcp" in this case.

sendMessage

protected void sendMessage(byte[] msg,
               boolean isClient)
                    throws IOException

Send message to whoever is connected to us. Uses the topmost via address to send to.

Specified by:

sendMessage in class ConnectionOrientedMessageChannel

Parameters:

msg - is the message to send.

isClient -

Throws:

IOException

sendMessage

public void sendMessage(byte[] message,
               InetAddress receiverAddress,
               int receiverPort,
               boolean retry)
                 throws IOException

Send a message to a specified address.

Specified by:

sendMessage in class MessageChannel

Parameters:

message - Pre-formatted message to send.

receiverAddress - Address to send it to.

receiverPort - Receiver port.

Throws:

IOException - If there is a problem connecting or sending.

sendTCPMessage

public void sendTCPMessage(byte[] message,
                  InetAddress receiverAddress,
                  int receiverPort,
                  boolean retry)
                    throws IOException

Send a message to a specified address.

Parameters:

message - Pre-formatted message to send.

receiverAddress - Address to send it to.

receiverPort - Receiver port.

Throws:

IOException - If there is a problem connecting or sending.

onNewSocket

public void onNewSocket(byte[] message)

handleException

public void handleException(ParseException ex,
                   SIPMessage sipMessage,
                   Class hdrClass,
                   String header,
                   String message)
                     throws ParseException

Exception processor for exceptions detected from the parser. (This is invoked by the parser when an error is detected).

Parameters:

sipMessage - -- the message that incurred the error.

ex - -- parse exception detected by the parser.

header - -- header that caused the error.

message - -- message where this header was detected.

Throws:

ParseException - Thrown if we want to reject the message.

equals

public boolean equals(Object other)

Equals predicate.

Overrides:

equals in class Object

Parameters:

other - is the other object to compare ourselves to for equals

isSecure

public boolean isSecure()

TCP Is not a secure protocol.

Specified by:

isSecure in class MessageChannel

getLastActivityTimestamp

public long getLastActivityTimestamp()

triggerConnectSuccess

public void triggerConnectSuccess()

triggerConnectFailure

public void triggerConnectFailure(Queue<NioTcpMessageProcessor.PendingData> failedMsgs)