org.alfresco.jlan.oncrpc

Class TcpRpcPacketHandler

java.lang.Object

org.alfresco.jlan.server.SocketPacketHandler

org.alfresco.jlan.oncrpc.TcpRpcPacketHandler

All Implemented Interfaces:

Runnable, PacketHandlerInterface

Direct Known Subclasses:

MultiThreadedTcpRpcPacketHandler

public class TcpRpcPacketHandler
extends SocketPacketHandler
implements Runnable

TCP RPC Packet Handler Class

Processes RPC requests received via TCP session.

Author:

gkspencer

Constructor Summary

Constructors

Constructor and Description
TcpRpcPacketHandler(Socket socket, int maxRpcSize) Class constructor to create a TCP RPC handler for a client.
TcpRpcPacketHandler(TcpRpcSessionHandler handler, int sessId, RpcProcessor server, Socket socket, int maxRpcSize) Class constructor to create a TCP RPC handler for a server.

Method Summary

Methods

Modifier and Type	Method and Description
protected RpcPacket	allocateRpcPacket(int maxSize) Allocate an RPC packet for receiving an incoming request.
void	closePacketHandler() Close the session
protected void	deallocateRpcPacket(RpcPacket pkt) Deallocate an RPC packet, default method does nothing but a pooled implementation may return the packet to the pool.
protected TcpRpcSessionHandler	getHandler() Return the associated session handler
int	getMaximumRpcSize() Return the maximum RPC size accepted
String	getProtocolName() Return the protocol name
int	getSessionId() Return the session id
protected void	processRpc(RpcPacket rpc) Process an RPC request.
protected int	receiveRpc(byte[] buffer, int offset, int maxLen) Read an RPC request/response
protected int	receiveRpc(RpcPacket rpc) Read an RPC request/response
void	run() Thread to read and process the RPC requests for this session
protected void	sendRpc(RpcPacket rpc) Send an RPC request/response packet

Methods inherited from class org.alfresco.jlan.server.SocketPacketHandler

availableBytes, getSocket, readPacket, writePacket

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpRpcPacketHandler

public TcpRpcPacketHandler(TcpRpcSessionHandler handler,
                   int sessId,
                   RpcProcessor server,
                   Socket socket,
                   int maxRpcSize)
                    throws IOException

Class constructor to create a TCP RPC handler for a server.

Parameters:

handler - TcpRpcSessionHandler

sessId - int

server - RpcProcessor

socket - Socket

maxRpcSize - int

Throws:

IOException

TcpRpcPacketHandler

public TcpRpcPacketHandler(Socket socket,
                   int maxRpcSize)
                    throws IOException

Class constructor to create a TCP RPC handler for a client.

Parameters:

socket - Socket

maxRpcSize - int

Throws:

IOException

Method Detail

getProtocolName

public String getProtocolName()

Return the protocol name

Specified by:

getProtocolName in interface PacketHandlerInterface

Specified by:

getProtocolName in class SocketPacketHandler

Returns:

String

getSessionId

public final int getSessionId()

Return the session id

Returns:

int

getMaximumRpcSize

public final int getMaximumRpcSize()

Return the maximum RPC size accepted

Returns:

int

getHandler

protected final TcpRpcSessionHandler getHandler()

Return the associated session handler

Returns:

TcpRpcSessionHandler

run

public void run()

Thread to read and process the RPC requests for this session

Specified by:

run in interface Runnable

closePacketHandler

public void closePacketHandler()

Close the session

Specified by:

closePacketHandler in interface PacketHandlerInterface

Overrides:

closePacketHandler in class SocketPacketHandler

sendRpc

protected final void sendRpc(RpcPacket rpc)
                      throws IOException

Send an RPC request/response packet

Parameters:

rpc - RpcPacket

Throws:

IOException

receiveRpc

protected final int receiveRpc(RpcPacket rpc)
                        throws IOException

Read an RPC request/response

Parameters:

rpc - RpcPacket

Returns:

int

Throws:

IOException

receiveRpc

protected final int receiveRpc(byte[] buffer,
             int offset,
             int maxLen)
                        throws IOException

Read an RPC request/response

Parameters:

buffer - byte[]

offset - int

maxLen - int

Returns:

int

Throws:

IOException

allocateRpcPacket

protected RpcPacket allocateRpcPacket(int maxSize)

Allocate an RPC packet for receiving an incoming request. This method must be overridden for multi-threaded implementations.

Parameters:

maxSize - int

Returns:

RpcPacket

deallocateRpcPacket

protected void deallocateRpcPacket(RpcPacket pkt)

Deallocate an RPC packet, default method does nothing but a pooled implementation may return the packet to the pool.

Parameters:

pkt - RpcPacket

processRpc

protected void processRpc(RpcPacket rpc)
                   throws IOException

Process an RPC request. This method must be overridden for multi-threaded implementations.

Parameters:

rpc - RpcPacket

Throws:

IOException