ch.icosys.popjava.core.combox

Class Combox<T>

java.lang.Object

ch.icosys.popjava.core.combox.Combox<T>

Type Parameters:

T - The "real" connection of the Combox, be it a Socket or a Pipe.

Direct Known Subclasses:

ComboxPlugin, ComboxSocket

public abstract class Combox<T>
extends java.lang.Object

This class is the base implementation for all Combox in the POP-Java library All other combox must inherit from this class

Field Summary

Fields

Modifier and Type	Field and Description
protected POPAccessPoint	accessPoint
protected boolean	available
protected BufferFactory	bufferFactory
protected static int	CLOSE_SUBCONNECTION
protected Configuration	conf
protected static int	OPEN_BIDIRECTIONAL
protected T	peerConnection
protected static int	PING
protected POPRemoteCaller	remoteCaller
protected static int	SEND_REMOTE_AP
protected int	timeOut

Constructor Summary

Constructors

Constructor and Description
Combox() This is used by ServerCombox (server).
Combox(java.lang.String networkUUID) This is used by Combox (client).

Method Summary

Modifier and Type	Method and Description
protected boolean	bindToBroker(int connectionID)
void	close(int connectionID) Close the connection
protected void	close(int connectionID, boolean informPartner) Close the connection
protected abstract void	closeInternal()
protected abstract boolean	connectToServer() Connect to the other side
boolean	connectToServer(Broker broker, POPAccessPoint accesspoint, int timeout) Connect to a ServerCombox on the other side, this will result in a Combox (client mode) communicating with a Combox (server mode).
protected abstract boolean	exportConnectionInfo() Setup POPRemoteCaller (remoteCaller) variable which is going to be made available to the user.
POPAccessPoint	getAccessPoint() Return the access point we are connected to
BufferFactory	getBufferFactory() Get the associated buffer factory
java.lang.String	getNetworkUUID() The network we are connecting or are connected to.
POPRemoteCaller	getRemoteCaller() Information about who we are talking too
protected void	handleComboxMessages(POPBuffer tempBuffer)
int	makeBidirectional(Broker broker) This function can be called to transform a client combox into a server combox.
abstract int	receive(POPBuffer buffer, int requestId, int connectionID) Receive buffer from the other side
protected abstract boolean	receiveNetworkName() Called by the server client, it will receive the network name This must use the basic peerConnection capabilities.
protected void	registerCommuncation()
protected int	registerNewConnection()
abstract int	send(POPBuffer buffer) Send the buffer to the other side
protected abstract boolean	sendNetworkName() Called by the client, it send the name of the network its in.
protected abstract boolean	serverAccept() Server accept connection.
boolean	serverAccept(Broker broker, T peerConnection) Accept a connection from connectToServer().
void	setBufferFactory(BufferFactory bufferFactory) Associate a buffer factory to the combox
void	setNetworkUUID(java.lang.String networkUUID) Set the new ID of this network

Methods inherited from class java.lang.Object

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

Field Detail

SEND_REMOTE_AP

protected static final int SEND_REMOTE_AP

See Also:

Constant Field Values

OPEN_BIDIRECTIONAL

protected static final int OPEN_BIDIRECTIONAL

See Also:

Constant Field Values

CLOSE_SUBCONNECTION

protected static final int CLOSE_SUBCONNECTION

See Also:

Constant Field Values

PING

protected static final int PING

See Also:

Constant Field Values

timeOut

protected int timeOut

accessPoint

protected POPAccessPoint accessPoint

available

protected boolean available

bufferFactory

protected BufferFactory bufferFactory

peerConnection

protected T peerConnection

remoteCaller

protected POPRemoteCaller remoteCaller

conf

protected final Configuration conf

Constructor Detail

Combox

public Combox()

This is used by ServerCombox (server). Create a new combox from a server. Call #serverAccept(java.lang.Object) to let the client connect.

Combox

public Combox(java.lang.String networkUUID)

This is used by Combox (client). Create a combox for a client. Call #connectToServer(ch.icosys.popjava.core.baseobject.POPAccessPoint, int) to actually connect the client.

Parameters:

networkUUID - The network UUID that will be send to the other end

Method Detail

registerNewConnection

protected int registerNewConnection()

connectToServer

public final boolean connectToServer(Broker broker,
                                     POPAccessPoint accesspoint,
                                     int timeout)

Connect to a ServerCombox on the other side, this will result in a Combox (client mode) communicating with a Combox (server mode).

Parameters:

broker - Broker that is behind this connection

accesspoint - Access point of the other side combox

timeout - Connection time out

Returns:

true if the connection is established

serverAccept

public final boolean serverAccept(Broker broker,
                                  T peerConnection)

Accept a connection from connectToServer(). Communicate with Client mode Combox.

Parameters:

peerConnection - the incoming connection

Returns:

true if the connection is established correctly, false otherwise

exportConnectionInfo

protected abstract boolean exportConnectionInfo()

Setup POPRemoteCaller (remoteCaller) variable which is going to be made available to the user.

Returns:

true if the operation succeeded

sendNetworkName

protected abstract boolean sendNetworkName()

Called by the client, it send the name of the network its in. This must use the basic peerConnection capabilities.

Returns:

true if the operation succeeded

receiveNetworkName

protected abstract boolean receiveNetworkName()

Called by the server client, it will receive the network name This must use the basic peerConnection capabilities.

Returns:

true if the operation succeeded

connectToServer

protected abstract boolean connectToServer()

Connect to the other side

Returns:

true if the connection succeed

serverAccept

protected abstract boolean serverAccept()

Server accept connection. Usually setup T I/O streams. NOTE you should NEVER use this method directly, use #serverAccept(java.lang.Object)

Returns:

true if the server accept the connection successfully

send

public abstract int send(POPBuffer buffer)

Send the buffer to the other side

Parameters:

buffer - The buffer to send

Returns:

Number of byte sent

receive

public abstract int receive(POPBuffer buffer,
                            int requestId,
                            int connectionID)

Receive buffer from the other side

Parameters:

buffer - Buffer to receive

requestId - The ID of the request

Returns:

Number of byte received

close

public void close(int connectionID)

Close the connection

close

protected void close(int connectionID,
                     boolean informPartner)

Close the connection

closeInternal

protected abstract void closeInternal()

setBufferFactory

public void setBufferFactory(BufferFactory bufferFactory)

Associate a buffer factory to the combox

Parameters:

bufferFactory - The buffer factory to associate

getBufferFactory

public BufferFactory getBufferFactory()

Get the associated buffer factory

Returns:

The associated buffer factory

getAccessPoint

public POPAccessPoint getAccessPoint()

Return the access point we are connected to

Returns:

the access point

getRemoteCaller

public POPRemoteCaller getRemoteCaller()

Information about who we are talking too

Returns:

the client connected on the other side

getNetworkUUID

public java.lang.String getNetworkUUID()

The network we are connecting or are connected to.

Returns:

the network UUID

setNetworkUUID

public void setNetworkUUID(java.lang.String networkUUID)

Set the new ID of this network

Parameters:

networkUUID - set the network UUID

makeBidirectional

public int makeBidirectional(Broker broker)

This function can be called to transform a client combox into a server combox.

bindToBroker

protected boolean bindToBroker(int connectionID)

handleComboxMessages

protected void handleComboxMessages(POPBuffer tempBuffer)

registerCommuncation

protected void registerCommuncation()