CSP Class Reference

Inheritance diagram for CSP:

Collaboration diagram for CSP:

Public Member Functions
	AddPersistentDevice (_.Library.String device)
	Add the specified device to the list of persistent devices. More...
_.Library.Boolean	IsPersistent (_.Library.String device)
	Check if the specified device is in the list of persistent devices.
	NextPersistentDevice (_.Library.String device, _.Library.Integer direction)
	Given a device, this method returns the next persistent device in this list, in collation order. More...
	PurgePersistentDevices ()
	This method will remove any devices in the persistent list that are no longer open.
	RemoveAllPersistentDevices ()
	Remove all devices marked as persistent. More...
	RemovePersistentDevice (_.Library.String device)
	Remove the specified device from the set of persistent devices. More...

Public Attributes
	AuthTokenInfo
	More...
	SQLGatewayTimeout
	Timeout (in seconds) for SQL Gateway connections. More...
	persistentDevices
	Array of devices that should not be closed after each request. More...

Member Function Documentation

AddPersistentDevice()

AddPersistentDevice

(

_.Library.String

device

)

Add the specified device to the list of persistent devices.

Devices in this list will not be closed after each request.

NextPersistentDevice()

NextPersistentDevice	(	_.Library.String	device,
		_.Library.Integer	direction
	)

Given a device, this method returns the next persistent device in this list, in collation order.

This can be used to iterate over the list of devices.

device indicates the current location of the iterator. Specify "" to retrieve the first device

direction specify 1 to retrieve the next device in collation order, or -1 to retrieve the previous device. The default is 1.

returns the next device, or "" if there are no more devices.

RemoveAllPersistentDevices()

RemoveAllPersistentDevices

(

)

Remove all devices marked as persistent.

The devices are not closed immediately;

they will be closed at the end of the current request

RemovePersistentDevice()

RemovePersistentDevice

(

_.Library.String

device

)

Remove the specified device from the set of persistent devices.

This will allow the device to be closed normally after the current request.

Member Data Documentation

AuthTokenInfo

AuthTokenInfo

 

 

SQLGatewayTimeout

SQLGatewayTimeout

Timeout (in seconds) for SQL Gateway connections.

If a connection

has not been used for longer than this time, it will be terminated. The timeout is applied at the end of each CSP request.  

persistentDevices

persistentDevices

Array of devices that should not be closed after each request.