openlsd.network.client.get.LSDClientGet Class Reference

Inheritance diagram for openlsd.network.client.get.LSDClientGet:

[legend]

Collaboration diagram for openlsd.network.client.get.LSDClientGet:

[legend]

List of all members.

Detailed Description

Class LSDClientGet is the class that defines function to offer service to client part for Get.

Author:: Frederic Bregier LGPL


Public Member Functions
	LSDClientGet (LSDClientGetSessionHandler lscshext, String Hostname, int ServerPort, boolean immediate, boolean keepalived)
	LSDClientGet (String Hostname, int ServerPort, boolean immediate, boolean keepalived)
	LSDClientGet (LSDClientGetSessionHandler lscshext, String Hostname, int ServerPort, boolean ServerCompressed, boolean ClientCompressed, boolean immediate, boolean keepalived)
	LSDClientGet (String Hostname, int ServerPort, boolean ServerCompressed, boolean ClientCompressed, boolean immediate, boolean keepalived)
int	getDataToObject (boolean unique, long legacy, long storage, long document, Object object)
int	getNoAckDataToObject (boolean unique, long legacy, long storage, long document, Object object)
void	lock ()
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	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
LSDClientCommonSessionHandler	createSessionHandler ()
Private Member Functions
void	getData (boolean unique, long legacy, long storage, long document, Object object)
void	getNoAckData (boolean unique, long legacy, long storage, long document, Object object)

Constructor & Destructor Documentation

openlsd.network.client.get.LSDClientGet.LSDClientGet	(	LSDClientGetSessionHandler	lscshext,
		String	Hostname,
		int	ServerPort,
		boolean	immediate,
		boolean	keepalived
	)

Create a new ClientGet using a specific SessionHandler that extends the LSDClientGetSessionHandler class and a specific Hostname and serverPort.

Parameters:

	lscshext
	Hostname
	ServerPort
	immediate
	keepalived

openlsd.network.client.get.LSDClientGet.LSDClientGet	(	String	Hostname,
		int	ServerPort,
		boolean	immediate,
		boolean	keepalived
	)

Create a new ClientGet using a specific Hostname and serverPort.

Parameters:

	Hostname
	ServerPort
	immediate
	keepalived

openlsd.network.client.get.LSDClientGet.LSDClientGet	(	LSDClientGetSessionHandler	lscshext,
		String	Hostname,
		int	ServerPort,
		boolean	ServerCompressed,
		boolean	ClientCompressed,
		boolean	immediate,
		boolean	keepalived
	)

Create a new ClientGet using a specific SessionHandler that extends the LSDClientGetSessionHandler class and a specific Hostname and serverPort and the properties of compression for server and client part.

Parameters:

	lscshext
	Hostname
	ServerPort
	ServerCompressed
	ClientCompressed
	immediate
	keepalived

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

Create a new ClientGet using a specific Hostname and serverPort and the properties of compression for server and client part.

Parameters:

	Hostname
	ServerPort
	ServerCompressed
	ClientCompressed
	immediate
	keepalived

Member Function Documentation

LSDClientCommonSessionHandler openlsd.network.client.get.LSDClientGet.createSessionHandler ( ) [protected, virtual]

Create a SessionHandler. This function has to be rewritten by classes that extends this one.

Returns:: a new SessionHandler

Implements openlsd.network.client.common.LSDClientCommon.

Reimplemented in openlsd.multiple.ophandler.extension.LSDPoolClientGet, and openlsd.web.extension.LSDWebClientGet.

void openlsd.network.client.get.LSDClientGet.getData	(	boolean	unique,
		long	legacy,
		long	storage,
		long	document,
		Object	object
	)			`[private]`

Ask to get Data (file) identified by the triple legacy, storage and document, and put the result through either the object as an array of byte, or through another object which implies an extend of LSDClientGetSessionHandler with a new version of messageGetBlock.

The boolean unique set if the get should close the connection after the full reception (true), or not (false).

This function is called by other calls to get data.

This function uses acknowledge of each block.

Parameters:

	unique
	legacy
	storage
	document
	object	(by default, if null becomes an array of byte allocated with "new byte[0]")

int openlsd.network.client.get.LSDClientGet.getDataToObject	(	boolean	unique,
		long	legacy,
		long	storage,
		long	document,
		Object	object
	)

Ask to get Data (file) identified by the triple legacy, storage and document, and put the result in the result object, which is by default an array of byte or another object controled by another object which implies an extend of LSDClientGetSessionHandler with a new version of messageGetBlock.

The boolean unique set if the get should close the connection after the full reception (true), or not (false).

This function uses acknowledge of each block.

Parameters:

	unique
	legacy
	storage
	document
	object	(by default, if null becomes an array of byte allocated with "new byte[0]")

Returns:: the status of the operation

void openlsd.network.client.get.LSDClientGet.getNoAckData	(	boolean	unique,
		long	legacy,
		long	storage,
		long	document,
		Object	object
	)			`[private]`

Ask to get Data (file) identified by the triple legacy, storage and document, and put the result through either the object as an array of byte, or through another object which implies an extend of LSDClientGetSessionHandler with a new version of messageGetBlock.

The boolean unique set if the get should close the connection after the full reception (true), or not (false).

This function is called by other calls to get data.

This function uses no acknowledge for each block (quicker).

Parameters:

	unique
	legacy
	storage
	document
	object	(by default, if null becomes an array of byte allocated with "new byte[0]")

int openlsd.network.client.get.LSDClientGet.getNoAckDataToObject	(	boolean	unique,
		long	legacy,
		long	storage,
		long	document,
		Object	object
	)

Ask to get Data (file) identified by the triple legacy, storage and document, and put the result in the result object, which is by default an array of byte or another object controled by another object which implies an extend of LSDClientGetSessionHandler with a new version of messageGetBlock.

The boolean unique set if the get should close the connection after the full reception (true), or not (false).

This function uses no acknowledge for each block (quicker).

Parameters:

	unique
	legacy
	storage
	document
	object	(by default, if null becomes an array of byte allocated with "new byte[0]")

Returns:: the status of the operation

void openlsd.network.client.common.LSDClientCommon.lock ( ) [inherited]

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

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

Init global structure like IoBufferAllocator

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

End global structure like IoBufferAllocator

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

End global structure like IoBufferAllocator

Parameters:

toexit

void openlsd.network.client.common.LSDClientCommon.connect	(	boolean	immediate,
		boolean	keepalived
	)			`[inherited]`

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 ( ) [inherited]

Join the connection, so as to finalize the connection process

Returns:: True if OK, else false

boolean openlsd.network.client.common.LSDClientCommon.sessionReconnect ( ) [inherited]

Enable to try to reconnect to the server if disconnected.

Returns:: True if reconnected, else False

boolean openlsd.network.client.common.LSDClientCommon.isConnected ( ) [inherited]

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, inherited]

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 ( ) [inherited]

clear session information

Object openlsd.network.client.common.LSDClientCommon.getObject ( ) [inherited]

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 ) [inherited]

Set the current user object of the session

Parameters:

object

Object openlsd.network.client.common.LSDClientCommon.clearObject ( ) [inherited]

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 ( ) [inherited]

Will close the current session and finalize the Client. Reconnection is still possible.

Reimplemented in openlsd.multiple.ophandler.extension.LSDPoolClientDelete, openlsd.multiple.ophandler.extension.LSDPoolClientGet, openlsd.multiple.ophandler.extension.LSDPoolClientInfo, openlsd.multiple.ophandler.extension.LSDPoolClientMove, and openlsd.multiple.ophandler.extension.LSDPoolClientPut.

void openlsd.network.client.common.LSDClientCommon.realClose ( ) [inherited]

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

int openlsd.network.client.common.LSDClientCommon.getStatus ( ) [inherited]

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.