com.aldebaran.qi

Class Session

java.lang.Object

com.aldebaran.qi.Session

public class Session
extends Object

Class that allows using the messaging layer: it is responsible for connecting services together locally or over the network.

The list of available services is contained in the ServiceDirectory which runs on a Session acting as the entry point for other sessions to connect to. Not all Sessions need to have a ServiceDirectory, they can also be connected to a Session that already has one. When a Session exposes a service, other connected sessions can contact that service. When Sessions connect to each other, they create an undirected graph.

This class allows registering and exposing a new QiService or retrieving one as an AnyObject.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Session.ConnectionListener

Constructor Summary

Constructors

Modifier	Constructor and Description
	Session() Create a qimessaging session.
protected	Session(long session)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnectionListener(Session.ConnectionListener listener)
Future<Void>	close() Close connection to Service Directory
Future<Void>	connect(String serviceDirectoryAddress) Try to connect to given address.
List<String>	endpoints() List of URL session endpoints. The return list is not modifiable.
protected void	finalize() Called by garbage collector Finalize is overriden to manually delete C++ data
boolean	isConnected()
void	loadService(String name)
void	onDisconnected(String callback, Object object) Deprecated.
int	registerService(String name, AnyObject object) Register service on Service Directory
void	removeConnectionListener(Session.ConnectionListener listener)
Future<AnyObject>	service(String name) Ask for remote service to Service Directory.
void	setClientAuthenticator(ClientAuthenticator authenticator)
void	setClientAuthenticatorFactory(ClientAuthenticatorFactory factory)
Future<Void>	unregisterService(int idx) Unregister service from Service Directory
Future<Void>	waitForService(String serviceName) Create future for wait a service is ready to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

Session

public Session()

Create a qimessaging session.

Session

protected Session(long session)

Method Detail

isConnected

public boolean isConnected()

Returns:

true is session is connected, false otherwise

connect

public Future<Void> connect(String serviceDirectoryAddress)

Try to connect to given address.

Parameters:

serviceDirectoryAddress - Address to connect to.

Throws:

Exception - on error.

service

public Future<AnyObject> service(String name)

Ask for remote service to Service Directory.

Parameters:

name - Name of service.

Returns:

the AnyObject future

close

public Future<Void> close()

Close connection to Service Directory

Returns:

Future to track/linked the effective close

finalize

protected void finalize()
                 throws Throwable

Called by garbage collector Finalize is overriden to manually delete C++ data

Overrides:

finalize in class Object

Throws:

Throwable

registerService

public int registerService(String name,
                  AnyObject object)

Register service on Service Directory

Parameters:

name - Name of new service

object - Instance of service

Returns:

the id of the service

unregisterService

public Future<Void> unregisterService(int idx)

Unregister service from Service Directory

Parameters:

idx - is return by registerService

Returns:

Future to track/linked to the complete finished

See Also:

registerService(String, AnyObject)

onDisconnected

@Deprecated
public void onDisconnected(String callback,
                             Object object)

Deprecated.

addConnectionListener

public void addConnectionListener(Session.ConnectionListener listener)

removeConnectionListener

public void removeConnectionListener(Session.ConnectionListener listener)

setClientAuthenticatorFactory

public void setClientAuthenticatorFactory(ClientAuthenticatorFactory factory)

setClientAuthenticator

public void setClientAuthenticator(ClientAuthenticator authenticator)

loadService

public void loadService(String name)

endpoints

public List<String> endpoints()

List of URL session endpoints.
The return list is not modifiable.

Returns:

List of URL session endpoints.

waitForService

public Future<Void> waitForService(String serviceName)

Create future for wait a service is ready to use.

Parameters:

serviceName - Service name

Returns:

Future to track/link service connection