ch.icosys.popjava.core.combox.plugin

Class ComboxPlugin

java.lang.Object

ch.icosys.popjava.core.combox.Combox<java.lang.Object>

ch.icosys.popjava.core.combox.plugin.ComboxPlugin

public class ComboxPlugin
extends Combox<java.lang.Object>

This class defined the interface for each new combox plug-in

Field Summary

Fields inherited from class ch.icosys.popjava.core.combox.Combox

accessPoint, available, bufferFactory, CLOSE_SUBCONNECTION, conf, OPEN_BIDIRECTIONAL, peerConnection, PING, remoteCaller, SEND_REMOTE_AP, timeOut

Constructor Summary

Constructors

Constructor and Description
ComboxPlugin()

Method Summary

Modifier and Type	Method and Description
void	close(int connectionID) Close the connection
protected void	closeInternal()
protected boolean	connectToServer() Connect to the other side
protected boolean	exportConnectionInfo() Setup POPRemoteCaller (remoteCaller) variable which is going to be made available to the user.
int	receive(POPBuffer buffer, int requestId, int connectionID) Receive buffer from the other side
protected boolean	receiveNetworkName() Called by the server client, it will receive the network name This must use the basic peerConnection capabilities.
int	send(POPBuffer buffer) Send the buffer to the other side
protected boolean	sendNetworkName() Called by the client, it send the name of the network its in.
protected boolean	serverAccept() Server accept connection.

Methods inherited from class ch.icosys.popjava.core.combox.Combox

bindToBroker, close, connectToServer, getAccessPoint, getBufferFactory, getNetworkUUID, getRemoteCaller, handleComboxMessages, makeBidirectional, registerCommuncation, registerNewConnection, serverAccept, setBufferFactory, setNetworkUUID

Methods inherited from class java.lang.Object

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

Constructor Detail

ComboxPlugin

public ComboxPlugin()

Method Detail

close

public void close(int connectionID)

Description copied from class: Combox

Close the connection

Overrides:

close in class Combox<java.lang.Object>

connectToServer

protected boolean connectToServer()

Description copied from class: Combox

Connect to the other side

Specified by:

connectToServer in class Combox<java.lang.Object>

Returns:

true if the connection succeed

receive

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

Description copied from class: Combox

Receive buffer from the other side

Specified by:

receive in class Combox<java.lang.Object>

Parameters:

buffer - Buffer to receive

requestId - The ID of the request

Returns:

Number of byte received

send

public int send(POPBuffer buffer)

Description copied from class: Combox

Send the buffer to the other side

Specified by:

send in class Combox<java.lang.Object>

Parameters:

buffer - The buffer to send

Returns:

Number of byte sent

exportConnectionInfo

protected boolean exportConnectionInfo()

Description copied from class: Combox

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

Specified by:

exportConnectionInfo in class Combox<java.lang.Object>

Returns:

true if the operation succeeded

sendNetworkName

protected boolean sendNetworkName()

Description copied from class: Combox

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

Specified by:

sendNetworkName in class Combox<java.lang.Object>

Returns:

true if the operation succeeded

receiveNetworkName

protected boolean receiveNetworkName()

Description copied from class: Combox

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

Specified by:

receiveNetworkName in class Combox<java.lang.Object>

Returns:

true if the operation succeeded

serverAccept

protected boolean serverAccept()

Description copied from class: Combox

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

Specified by:

serverAccept in class Combox<java.lang.Object>

Returns:

true if the server accept the connection successfully

closeInternal

protected void closeInternal()

Specified by:

closeInternal in class Combox<java.lang.Object>