Package com.aldebaran.qi

Interface Summary

Interface	Description
ClientAuthenticator	Interface used to create an authenticator for connections to a given Session.
Consumer<T>	Class used to provide a mechanism for chaining Futures by supplying it to: Future.andThenConsume(Consumer) and Future.thenConsume(Consumer)
Function<T,R>	Interface used to provide a mechanism for chaining Futures by supplying it to: Future.andThenApply(Function), Future.andThenCompose(Function), Future.thenApply(Function) and Future.thenCompose(Function)
Future.Callback<T>
Predicate<T>	Represents a predicate (boolean-valued function) of one argument.
Promise.CancelRequestCallback<T>	An implementation of this interface can be connected to a Promise in order to be called when the Promise receives a cancel request.
QiSignalListener	An implementation of this interface can be set as a callback to be invoked every time the specified signal is triggered.
Session.ConnectionListener
Supplier<T>	Represents a supplier of results.

Class Summary

Class	Description
AnyObject	Class that provides type erasure on objects.
Application	Class responsible for initializing the qi framework.
ClientAuthenticatorFactory	Abstract class that represents a factory for creating ClientAuthenticators.
DynamicObjectBuilder	Class that exposes directly an AnyObject that can be manipulated.
Future<T>	Future extends the standard Java Future and represents the result of an asynchronous computation.
NativeTools	Utilities tools to communicate with native code (Code in C++)
Optional<T>	For documentation purpose, please refer to https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html TODO : remove when java 1.8
Promise<T>	Promise is a writable, single assignment container which sets the value of the Future.
Property<T>	Represents a property from distant object or can be advertised
QiService	Interface used to create a service that can be registered to a Session
QiSignalConnection	Class that represents a connection to a signal.
RawApplication	Class responsible for initializing the qi framework, but without creating a Session.
ServiceDirectory	Class responsible for the administration of the available services in a Session.
Session	Class that allows using the messaging layer: it is responsible for connecting services together locally or over the network.
Tuple	Class that represents a list of values of different fixed types.
TypeToken<T>	Class used to represent a generic type T and to extract its type information at runtime.
UserTokenAuthenticator	Specific ClientAuthenticator that authenticates a user using a token.

Enum Summary

Enum	Description
DynamicObjectBuilder.ObjectThreadingModel	Enum to declare the thread-safeness state of an AnyObject instance.
FutureCallbackType	Enum to specify how callbacks registered to a Future are called.

Exception Summary

Exception	Description
AdvertisementException	An AdvertisementException is thrown when an error occurs during the advertisement of a method, a signal or a property.
DynamicCallException	A DynamicCallException is thrown to indicate that an error occurred in the messaging layer during a call.
QiConversionException	A QiConversionException is an exception indicating that a custom object could not be serialized and deserialized to or from a supported type.
QiException	QiException is a subclass of the standard Java Exception.
QiRuntimeException	QiRuntimeException is a subclass of the standard Java RuntimeException.
QiSlotException	A QiSlotException is thrown when a slot could not be invoked due to a missing QiSlot annotation, an IllegalAccessException, an IllegalArgumentException or an InvocationTargetException.

Annotation Types Summary

Annotation Type	Description
AdvertisedMethodDescription	Annotation to add description to method inside interface managed by advertised method: DynamicObjectBuilder.advertiseMethods(Class, Object)
QiField	Annotation indicating that a field represents an element inside a Tuple.
QiSlot	Annotation indicating that a method can be used as a signal's callback.
QiStruct	Annotation indicating that a class represents a conversion from a Tuple.