Class DBus

java.lang.Object

javaforce.ipc.DBus

All Implemented Interfaces:

IPC

public class DBus
extends Object
implements IPC

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DBus.Options	Options provides increase control of DBus operations.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_ARRAY
static final String	TYPE_ARRAY_BOOLEAN
static final String	TYPE_ARRAY_DOUBLE
static final String	TYPE_ARRAY_INT16
static final String	TYPE_ARRAY_INT32
static final String	TYPE_ARRAY_INT64
static final String	TYPE_ARRAY_STRING
static final String	TYPE_ARRAY_UINT8
static final String	TYPE_BOOLEAN
static final String	TYPE_DICT
static final String	TYPE_DICT_CLOSE
static final String	TYPE_DICT_OPEN
static final String	TYPE_DOUBLE
static final String	TYPE_FD
static final String	TYPE_INT16
static final String	TYPE_INT32
static final String	TYPE_INT64
static final String	TYPE_OBJECT_PATH
static final String	TYPE_SIGNATURE
static final String	TYPE_STRING
static final String	TYPE_STRUCT
static final String	TYPE_STRUCT_CLOSE
static final String	TYPE_STRUCT_OPEN
static final String	TYPE_UINT16
static final String	TYPE_UINT32
static final String	TYPE_UINT64
static final String	TYPE_UINT8
static final String	TYPE_VARIANT

Constructor Summary

Constructors

Constructor	Description
DBus(EndPoint ep)	Create DBus with specified EndPoint.
DBus(EndPoint ep, DBus.Options options)	Create DBus with specified EndPoint and more detailed options.
DBus(EndPoint ep, DBusTransport transport)	Create DBus with specified EndPoint and transport.

Method Summary

Modifier and Type	Method	Description
boolean	connect()	Connects to message bus.
static EndPoint	createEndPoint(Object obj)	Create a client end point with system provided name.
static EndPoint	createEndPoint(String name, Object obj)	Create a EndPoint with specified name (servers).
static DBusTransport	createTransport()	Create transport suitable for OS.
boolean	disconnect()	Disconnects from message bus.
String	getBusName()	Returns bus name requested or assigned.
static String	getDataType(Object obj)	Returns DBus data type of obj.
Object	invoke(String dest, String method, Object... args)	Invokes method in remote end point.
static String	nameToPath(String name)	Convert a message bus name to object path.
static void	setTCPTransportPort(int port)	Set TCP port for systems that do not fully support DBus.
void	setTimeout(int ms)	Set timeout for reply.
boolean	signal(String method, Object... args)	Invokes a method in all bus members that have subscribed to the method.
boolean	subscribe(String sender, String method)	Subscribe to a signal from another client.
boolean	unsubscribe(String sender, String method)	Unsubscribe to a signal from another client.

Methods inherited from class Object

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

Field Details

TYPE_UINT8

public static final String TYPE_UINT8

See Also:

• Constant Field Values

TYPE_INT16

public static final String TYPE_INT16

See Also:

• Constant Field Values

TYPE_UINT16

public static final String TYPE_UINT16

See Also:

• Constant Field Values

TYPE_INT32

public static final String TYPE_INT32

See Also:

• Constant Field Values

TYPE_UINT32

public static final String TYPE_UINT32

See Also:

• Constant Field Values

TYPE_INT64

public static final String TYPE_INT64

See Also:

• Constant Field Values

TYPE_UINT64

public static final String TYPE_UINT64

See Also:

• Constant Field Values

TYPE_DOUBLE

public static final String TYPE_DOUBLE

See Also:

• Constant Field Values

TYPE_BOOLEAN

public static final String TYPE_BOOLEAN

See Also:

• Constant Field Values

TYPE_STRING

public static final String TYPE_STRING

See Also:

• Constant Field Values

TYPE_ARRAY

public static final String TYPE_ARRAY

See Also:

• Constant Field Values

TYPE_STRUCT

public static final String TYPE_STRUCT

See Also:

• Constant Field Values

TYPE_STRUCT_OPEN

public static final String TYPE_STRUCT_OPEN

See Also:

• Constant Field Values

TYPE_STRUCT_CLOSE

public static final String TYPE_STRUCT_CLOSE

See Also:

• Constant Field Values

TYPE_DICT

public static final String TYPE_DICT

See Also:

• Constant Field Values

TYPE_DICT_OPEN

public static final String TYPE_DICT_OPEN

See Also:

• Constant Field Values

TYPE_DICT_CLOSE

public static final String TYPE_DICT_CLOSE

See Also:

• Constant Field Values

TYPE_VARIANT

public static final String TYPE_VARIANT

See Also:

• Constant Field Values

TYPE_OBJECT_PATH

public static final String TYPE_OBJECT_PATH

See Also:

• Constant Field Values

TYPE_SIGNATURE

public static final String TYPE_SIGNATURE

See Also:

• Constant Field Values

TYPE_FD

public static final String TYPE_FD

See Also:

• Constant Field Values

TYPE_ARRAY_UINT8

public static final String TYPE_ARRAY_UINT8

See Also:

• Constant Field Values

TYPE_ARRAY_INT16

public static final String TYPE_ARRAY_INT16

See Also:

• Constant Field Values

TYPE_ARRAY_INT32

public static final String TYPE_ARRAY_INT32

See Also:

• Constant Field Values

TYPE_ARRAY_INT64

public static final String TYPE_ARRAY_INT64

See Also:

• Constant Field Values

TYPE_ARRAY_DOUBLE

public static final String TYPE_ARRAY_DOUBLE

See Also:

• Constant Field Values

TYPE_ARRAY_BOOLEAN

public static final String TYPE_ARRAY_BOOLEAN

See Also:

• Constant Field Values

TYPE_ARRAY_STRING

public static final String TYPE_ARRAY_STRING

See Also:

• Constant Field Values

Constructor Details

DBus

public DBus(EndPoint ep)

Create DBus with specified EndPoint.

DBus

public DBus(EndPoint ep,
 DBusTransport transport)

Create DBus with specified EndPoint and transport.

DBus

public DBus(EndPoint ep,
 DBus.Options options)

Create DBus with specified EndPoint and more detailed options.

Method Details

getDataType

public static String getDataType(Object obj)

Returns DBus data type of obj.

createTransport

public static DBusTransport createTransport()

Create transport suitable for OS.

createEndPoint

public static EndPoint createEndPoint(Object obj)

Create a client end point with system provided name.

Parameters:

obj - = where RPC methods reside

createEndPoint

public static EndPoint createEndPoint(String name,
 Object obj)

Create a EndPoint with specified name (servers).

Parameters:

name - = name of end point

obj - = where RPC methods reside

nameToPath

public static String nameToPath(String name)

Convert a message bus name to object path. org.freedesktop.DBus becomes /org/freedesktop/DBus

setTCPTransportPort

public static void setTCPTransportPort(int port)

Set TCP port for systems that do not fully support DBus. Examples: - Windows without native Windows Pipes support. - MacOS

connect

public boolean connect()

Connects to message bus.

Specified by:

connect in interface IPC

disconnect

public boolean disconnect()

Disconnects from message bus.

Specified by:

disconnect in interface IPC

setTimeout

public void setTimeout(int ms)

Set timeout for reply. Default = 30 seconds.

Parameters:

ms - = timeout (min = 3000, max = 60000)

getBusName

public String getBusName()

Returns bus name requested or assigned.

Specified by:

getBusName in interface IPC

invoke

public Object invoke(String dest,
 String method,
 Object... args)
              throws Exception

Invokes method in remote end point.

Specified by:

invoke in interface IPC

Parameters:

dest - = destination end point

method - = method to invoke

args - = arguments

Returns:

return value from remote method

Throws:

Exception - thrown if method returned at error message or no reply within timeout duration Errors could be method not found, mismatch arguments, etc.

signal

public boolean signal(String method,
 Object... args)

Invokes a method in all bus members that have subscribed to the method.

Specified by:

signal in interface IPC

See Also:

• subscribe(java.lang.String,java.lang.String)
• unsubscribe(java.lang.String,java.lang.String)

subscribe

public boolean subscribe(String sender,
 String method)

Subscribe to a signal from another client.

Specified by:

subscribe in interface IPC

unsubscribe

public boolean unsubscribe(String sender,
 String method)

Unsubscribe to a signal from another client.

Specified by:

unsubscribe in interface IPC