openlsd.network.client.common.LSDClientCommon Class Reference

Inheritance diagram for openlsd.network.client.common.LSDClientCommon:

Inheritance graph
[legend]
Collaboration diagram for openlsd.network.client.common.LSDClientCommon:

Collaboration graph
[legend]

List of all members.


Detailed Description

Class LSDClientCommon is the class that defines global functions to be extended by specific messages implementation.

Two kind of functions are to be defined :

Author:
Frederic Bregier LGPL

Public Member Functions

 LSDClientCommon (LSDClientCommonSessionHandler lscshext, String Hostname, int ServerPort, boolean immediate, boolean keepalived)
 LSDClientCommon (String Hostname, int ServerPort, boolean immediate, boolean keepalived)
 LSDClientCommon (LSDClientCommonSessionHandler lscshext, String Hostname, int ServerPort, boolean ServerCompressed, boolean ClientCompressed, boolean immediate, boolean keepalived)
 LSDClientCommon (String Hostname, int ServerPort, boolean ServerCompressed, boolean ClientCompressed, boolean immediate, boolean keepalived)
void connect (boolean immediate, boolean keepalived)
boolean connectionJoin ()
boolean sessionReconnect ()
boolean isConnected ()
void clear ()
Object getObject ()
void setObject (Object object)
Object clearObject ()
void close ()
void realClose ()
int getStatus ()
void initShared ()
void lock ()
void unlock ()
String toString ()

Static Public Member Functions

static void initClient ()
static void endClient ()
static void endClient (boolean toexit)
static boolean isSessionOK (IoSession session)

Public Attributes

String hostname = "localhost"
int serverPort = 8080
boolean serverCompressed = false
boolean clientCompressed = false
long idip = LSDConstants.invalide_idx
IoSession session = null
SocketConnector connector = null
LSDClientSession ls = null
LSDClientCommonSessionHandler lscsh = null
ExecutorService executorChainService = null
LSDPoolConnectionAbstract poolConnection = null

Protected Member Functions

abstract
LSDClientCommonSessionHandler 
createSessionHandler ()

Private Member Functions

void addKeepAlive ()

Private Attributes

ConnectFuture future = null
SocketSessionConfig config = null
InetSocketAddress inetSocketAddress = null
DefaultIoFilterChainBuilder chain = null
ReentrantLock lock = null
LSDKeepAliveFilter keepAliveFilter = null

Static Private Attributes

static IoBufferAllocator ioBufferAllocator = null

Constructor & Destructor Documentation

openlsd.network.client.common.LSDClientCommon.LSDClientCommon ( LSDClientCommonSessionHandler  lscshext,
String  Hostname,
int  ServerPort,
boolean  immediate,
boolean  keepalived 
)

Create a new ClientCommon using a specific SessionHandler that extends the LSDClientCommonSessionHandler class and a specific Hostname and serverPort. The client is immediately connected if immediate is true, else it will be connected after connectionJoint() will be called.

Parameters:
lscshext 
Hostname 
ServerPort 
immediate 
keepalived 

openlsd.network.client.common.LSDClientCommon.LSDClientCommon ( String  Hostname,
int  ServerPort,
boolean  immediate,
boolean  keepalived 
)

Create a new ClientCommon using a specific Hostname and serverPort. The client is immediately connected if immediate is true, else it will be connected after connectionJoint() will be called.

Parameters:
Hostname 
ServerPort 
immediate 
keepalived 

openlsd.network.client.common.LSDClientCommon.LSDClientCommon ( LSDClientCommonSessionHandler  lscshext,
String  Hostname,
int  ServerPort,
boolean  ServerCompressed,
boolean  ClientCompressed,
boolean  immediate,
boolean  keepalived 
)

Create a new ClientCommon using a specific SessionHandler that extends the LSDClientCommonSessionHandler class and a specific Hostname and serverPort and the properties of compression for server and client part. The client is immediately connected if immediate is true, else it will be connected after connectionJoint() will be called.

Parameters:
lscshext 
Hostname 
ServerPort 
ServerCompressed 
ClientCompressed 
immediate 
keepalived 

openlsd.network.client.common.LSDClientCommon.LSDClientCommon ( String  Hostname,
int  ServerPort,
boolean  ServerCompressed,
boolean  ClientCompressed,
boolean  immediate,
boolean  keepalived 
)

Create a new ClientCommon using a specific Hostname and serverPort and the properties of compression for server and client part. The client is immediately connected if immediate is true, else it will be connected after connectionJoint() will be called.

Parameters:
Hostname 
ServerPort 
ServerCompressed 
ClientCompressed 
immediate 
keepalived 


Member Function Documentation

static void openlsd.network.client.common.LSDClientCommon.initClient (  )  [static]

Init global structure like IoBufferAllocator

static void openlsd.network.client.common.LSDClientCommon.endClient (  )  [static]

End global structure like IoBufferAllocator

static void openlsd.network.client.common.LSDClientCommon.endClient ( boolean  toexit  )  [static]

End global structure like IoBufferAllocator

Parameters:
toexit 

abstract LSDClientCommonSessionHandler openlsd.network.client.common.LSDClientCommon.createSessionHandler (  )  [protected, pure virtual]

void openlsd.network.client.common.LSDClientCommon.addKeepAlive (  )  [private]

Add the Keep Alive feature to this session: Can only be added before connection is done!

void openlsd.network.client.common.LSDClientCommon.connect ( boolean  immediate,
boolean  keepalived 
)

The client is now to be connected to the server using the specific SessionHandler that extends the LSDClientCommonSessionHandler class. This function is called by the Constructor.

If the connection is not ok, then the function isConnected() returns false. The client is immediately connected if immediate is true, else it will be connected after connectionJoint() will be called.

Parameters:
immediate 
keepalived True if the chainFilter should add the keepalived feature (mandatory in immediate mode to true if the keepalived filter is wanted)

boolean openlsd.network.client.common.LSDClientCommon.connectionJoin (  ) 

Join the connection, so as to finalize the connection process

Returns:
True if OK, else false

boolean openlsd.network.client.common.LSDClientCommon.sessionReconnect (  ) 

Enable to try to reconnect to the server if disconnected.

Returns:
True if reconnected, else False

boolean openlsd.network.client.common.LSDClientCommon.isConnected (  ) 

Returns the status of the connection and clear the session if not connected (sessionStop)

Returns:
the status of the connection

static boolean openlsd.network.client.common.LSDClientCommon.isSessionOK ( IoSession  session  )  [static]

Test if the session is still OK

Parameters:
session 
Returns:
True if the session is OK, else False

void openlsd.network.client.common.LSDClientCommon.clear (  ) 

clear session information

Object openlsd.network.client.common.LSDClientCommon.getObject (  ) 

Return the current user object of the session

Returns:
the user object or null if no session or object

void openlsd.network.client.common.LSDClientCommon.setObject ( Object  object  ) 

Set the current user object of the session

Parameters:
object 

Object openlsd.network.client.common.LSDClientCommon.clearObject (  ) 

Return the current user object of the session before clear the object stored.

Returns:
the past user object or null if no session or object

void openlsd.network.client.common.LSDClientCommon.close (  ) 

void openlsd.network.client.common.LSDClientCommon.realClose (  ) 

Will totally close the current session and finalize the Client. Reconnection cannot be done.

int openlsd.network.client.common.LSDClientCommon.getStatus (  ) 

Return the status of the request: 1 running, 0 finished, -1 error system, -2 error as request, -3 error as unavailable request, -4 error as cannot restore to previous state, -5 error as bad client request, -6 error as no service.

Returns:
the status (-6 to 1)

void openlsd.network.client.common.LSDClientCommon.initShared (  ) 

Initialized a lock to enable shared connection among threads

Lock in case of shared connection (no synchronized since if connection are not shared, they can be done in parallel)

void openlsd.network.client.common.LSDClientCommon.unlock (  ) 

UnLock in case of shared connection

String openlsd.network.client.common.LSDClientCommon.toString (  ) 

Returns:
The String of the Client


Member Data Documentation

Hostname

Port for the server

Are messages compressed from Server

Are messages compressed from Client

Idip of server: not mandatory, should be set if needed after constructor

Associated session

Associated socket connector

Associated future connector

SocketSessionConfig openlsd.network.client.common.LSDClientCommon.config = null [private]

Associated Socket Session Config

Associated session info

Associated Session Handler

Associated ExecutorChainService

IoBufferAllocator openlsd.network.client.common.LSDClientCommon.ioBufferAllocator = null [static, private]

Associated IoBufferAllocator

Associated Socket Address

DefaultIoFilterChainBuilder openlsd.network.client.common.LSDClientCommon.chain = null [private]

Chain filter

Associated Lock for shared session between multiple thread

The referent pool of connections if this connection is taken from a pool of connections

The KeepAlive filter associated if any


The documentation for this class was generated from the following file: