BEAST
eu.baltrad.beast.adaptor.IAdaptor Interface Reference
Inheritance diagram for eu.baltrad.beast.adaptor.IAdaptor:
eu.baltrad.beast.adaptor.xmlrpc.XmlRpcAdaptor

Public Member Functions

String getName ()
 Returns the name that uniquely identifies this adaptor.
 
String getType ()
 Returns the type of this adaptor.
 
void handle (IBltMessage msg)
 Handles a message.
 
void handle (IBltMessage msg, IAdaptorCallback callback)
 Handles a message.
 

Detailed Description

Author
Anders Henja

Member Function Documentation

◆ getName()

String eu.baltrad.beast.adaptor.IAdaptor.getName ( )

Returns the name that uniquely identifies this adaptor.

Returns
the name of the adaptor

Implemented in eu.baltrad.beast.adaptor.xmlrpc.XmlRpcAdaptor.

◆ getType()

String eu.baltrad.beast.adaptor.IAdaptor.getType ( )

Returns the type of this adaptor.

Returns
the type of this adaptor (as defined when adding a new adaptor).

Implemented in eu.baltrad.beast.adaptor.xmlrpc.XmlRpcAdaptor.

◆ handle() [1/2]

void eu.baltrad.beast.adaptor.IAdaptor.handle ( IBltMessage msg)

Handles a message.

If this adaptor could not handle the message an AdaptorException should be thrown. However, it is optional to throw the exception and instead use a callback indicating an error,

See also
handle(IBltMessage, IAdaptorCallback). This means that the adaptor itself MAY have a callback function that triggers internally when this method is called.
Parameters
msgthe message
Exceptions
AdaptorException

Implemented in eu.baltrad.beast.adaptor.xmlrpc.XmlRpcAdaptor.

◆ handle() [2/2]

void eu.baltrad.beast.adaptor.IAdaptor.handle ( IBltMessage msg,
IAdaptorCallback callback )

Handles a message.

This message will post a callback if provided.

Parameters
msgthe message to send
callbackthe callback that should get the response (MAY BE NULL)
Exceptions
AdaptorException- on error or if not supported.

Implemented in eu.baltrad.beast.adaptor.xmlrpc.XmlRpcAdaptor.


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