module OBus_value: sig
.. end
D-Bus types, values and converters
Types
module T: sig
.. end
D-Bus types
Signatures
type
signature = T.sequence
exception Invalid_signature of string * string
Invalid_signature(signature, message)
is raised when a
signature is invalid. signature
is a string representation of
the signature (using D-Bus type codes) and message
is an error
message.
val string_of_signature : signature -> string
Returns a string representation of a signature using D-Bus type
codes. If the signature is not valid (for example it is too
long), it raises
OBus_value.Invalid_signature
.
val signature_of_string : string -> signature
val validate_signature : signature -> string option
Not all signatures are valid. validate
returns None
if the
given signature is a valid one, or Some reason
if it is
not.
Values
module V: sig
.. end
D-Bus values
Type converters
module C: sig
.. end
Type converters
Methods/signals arguments
type 'a
arguments = private {
|
arg_types : 'a C.sequence ; |
|
arg_names : string option list ; |
}
Type of a list of arguments used by methods and signals. It is
ensured that the number of single types contained in arg_types
is equal to the number of names.
val arguments : arg_types:'a C.sequence ->
arg_names:string option list -> 'a arguments
arguments ~arg_types ~arg_names
creates a list of
arguments. It raises Invalid_arg
if the number of single types
contained in arg_types
is not equal to the number of names.
val arg_types : 'a arguments -> 'a C.sequence
Returns the underlying sequence converter of a list of
arguments.
val arg_names : 'a arguments -> string option list
Returns the names of a list of arguments
Constructors
val arg_cons : string option * 'a C.single ->
'b arguments -> ('a * 'b) arguments
arg_cons (name, typ) arguments
adds the argument (name,
type)
to the beginning of arguments
val arg0 : unit arguments
val arg1 : string option * 'a C.single -> 'a arguments
val arg2 : string option * 'a C.single ->
string option * 'b C.single -> ('a * 'b) arguments
val arg3 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single -> ('a * 'b * 'c) arguments
val arg4 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
('a * 'b * 'c * 'd) arguments
val arg5 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
('a * 'b * 'c * 'd * 'e) arguments
val arg6 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
('a * 'b * 'c * 'd * 'e * 'f) arguments
val arg7 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
string option * 'g C.single ->
('a * 'b * 'c * 'd * 'e * 'f * 'g) arguments
val arg8 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
string option * 'g C.single ->
string option * 'h C.single ->
('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h) arguments
val arg9 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
string option * 'g C.single ->
string option * 'h C.single ->
string option * 'i C.single ->
('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i) arguments
val arg10 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
string option * 'g C.single ->
string option * 'h C.single ->
string option * 'i C.single ->
string option * 'j C.single ->
('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j) arguments
val arg11 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
string option * 'g C.single ->
string option * 'h C.single ->
string option * 'i C.single ->
string option * 'j C.single ->
string option * 'k C.single ->
('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k) arguments
val arg12 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
string option * 'g C.single ->
string option * 'h C.single ->
string option * 'i C.single ->
string option * 'j C.single ->
string option * 'k C.single ->
string option * 'l C.single ->
('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k * 'l)
arguments
val arg13 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
string option * 'g C.single ->
string option * 'h C.single ->
string option * 'i C.single ->
string option * 'j C.single ->
string option * 'k C.single ->
string option * 'l C.single ->
string option * 'm C.single ->
('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k * 'l * 'm)
arguments
val arg14 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
string option * 'g C.single ->
string option * 'h C.single ->
string option * 'i C.single ->
string option * 'j C.single ->
string option * 'k C.single ->
string option * 'l C.single ->
string option * 'm C.single ->
string option * 'n C.single ->
('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k * 'l * 'm * 'n)
arguments
val arg15 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
string option * 'g C.single ->
string option * 'h C.single ->
string option * 'i C.single ->
string option * 'j C.single ->
string option * 'k C.single ->
string option * 'l C.single ->
string option * 'm C.single ->
string option * 'n C.single ->
string option * 'o C.single ->
('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k * 'l * 'm * 'n * 'o)
arguments
val arg16 : string option * 'a C.single ->
string option * 'b C.single ->
string option * 'c C.single ->
string option * 'd C.single ->
string option * 'e C.single ->
string option * 'f C.single ->
string option * 'g C.single ->
string option * 'h C.single ->
string option * 'i C.single ->
string option * 'j C.single ->
string option * 'k C.single ->
string option * 'l C.single ->
string option * 'm C.single ->
string option * 'n C.single ->
string option * 'o C.single ->
string option * 'p C.single ->
('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k * 'l * 'm * 'n * 'o *
'p)
arguments