org.springframework.integration.ip.tcp
Class NetSocketWriter

java.lang.Object
  org.springframework.integration.ip.tcp.AbstractSocketWriter
      org.springframework.integration.ip.tcp.NetSocketWriter

All Implemented Interfaces:

MessageFormats, SocketWriter

public class NetSocketWriter
extends AbstractSocketWriter

A SocketWriter that writes to a Socket. The data is wrapped in a wire protocol based on the messageFormat property.

Author:

Gary Russell

Field Summary

protected java.net.Socket

socket

Fields inherited from class org.springframework.integration.ip.tcp.AbstractSocketWriter

messageFormat

Fields inherited from interface org.springframework.integration.ip.tcp.MessageFormats

ETX, FORMAT_CRLF, FORMAT_CUSTOM, FORMAT_LENGTH_HEADER, FORMAT_STX_ETX, STX

Constructor Summary

NetSocketWriter(java.net.Socket socket)
Constructs a NetSocketWriter for the Socket.

Method Summary

protected void	doClose() Called when an IO error
protected void	writeCrLfFormat(byte[] bytes) Write the data, followed by carriage return, line feed ('\r\n').
protected void	writeCustomFormat(byte[] bytes) Write the data using some custom protocol.
protected void	writeLengthFormat(byte[] bytes) Write the length of the data in a 4 byte integer (in network byte order) before the data itself.
protected void	writeStxEtxFormat(byte[] bytes) Write an STX (0x02) followed by the data, followed by ETX (0x03).

Methods inherited from class org.springframework.integration.ip.tcp.AbstractSocketWriter

setMessageFormat, write

Methods inherited from class java.lang.Object

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

Field Detail

socket

protected java.net.Socket socket

Constructor Detail

NetSocketWriter

public NetSocketWriter(java.net.Socket socket)

Constructs a NetSocketWriter for the Socket.

Parameters:

socket - The socket.

Method Detail

writeCrLfFormat

protected void writeCrLfFormat(byte[] bytes)
                        throws java.io.IOException

Description copied from class: AbstractSocketWriter

Write the data, followed by carriage return, line feed ('\r\n').

Specified by:

writeCrLfFormat in class AbstractSocketWriter

Throws:

java.io.IOException

writeCustomFormat

protected void writeCustomFormat(byte[] bytes)
                          throws java.io.IOException

Description copied from class: AbstractSocketWriter

Write the data using some custom protocol.

Specified by:

writeCustomFormat in class AbstractSocketWriter

Throws:

java.io.IOException

writeLengthFormat

protected void writeLengthFormat(byte[] bytes)
                          throws java.io.IOException

Description copied from class: AbstractSocketWriter

Write the length of the data in a 4 byte integer (in network byte order) before the data itself.

Specified by:

writeLengthFormat in class AbstractSocketWriter

Parameters:

bytes - The bytes to write.

Throws:

java.io.IOException

writeStxEtxFormat

protected void writeStxEtxFormat(byte[] bytes)
                          throws java.io.IOException

Description copied from class: AbstractSocketWriter

Write an STX (0x02) followed by the data, followed by ETX (0x03).

Specified by:

writeStxEtxFormat in class AbstractSocketWriter

Parameters:

bytes - The bytes to write.

Throws:

java.io.IOException

doClose

protected void doClose()

Description copied from class: AbstractSocketWriter

Called when an IO error

Specified by:

doClose in class AbstractSocketWriter