ubusmsg.h File Reference

#include <stdint.h>
#include <libubox/blob.h>

Go to the source code of this file.

Data Structures
struct	ubus_msghdr

Macros
#define	__packetdata   __attribute__((packed)) __attribute__((__aligned__(4)))
#define	UBUS_MSG_CHUNK_SIZE   65536
#define	UBUS_SYSTEM_OBJECT_EVENT   1
#define	UBUS_SYSTEM_OBJECT_ACL   2
#define	UBUS_SYSTEM_OBJECT_MONITOR   3
#define	UBUS_SYSTEM_OBJECT_MAX   1024

Enumerations
enum	ubus_msg_type {   UBUS_MSG_HELLO , UBUS_MSG_STATUS , UBUS_MSG_DATA , UBUS_MSG_PING ,   UBUS_MSG_LOOKUP , UBUS_MSG_INVOKE , UBUS_MSG_ADD_OBJECT , UBUS_MSG_REMOVE_OBJECT ,   UBUS_MSG_SUBSCRIBE , UBUS_MSG_UNSUBSCRIBE , UBUS_MSG_NOTIFY , UBUS_MSG_MONITOR ,   __UBUS_MSG_LAST }
enum	ubus_msg_attr {   UBUS_ATTR_UNSPEC , UBUS_ATTR_STATUS , UBUS_ATTR_OBJPATH , UBUS_ATTR_OBJID ,   UBUS_ATTR_METHOD , UBUS_ATTR_OBJTYPE , UBUS_ATTR_SIGNATURE , UBUS_ATTR_DATA ,   UBUS_ATTR_TARGET , UBUS_ATTR_ACTIVE , UBUS_ATTR_NO_REPLY , UBUS_ATTR_SUBSCRIBERS ,   UBUS_ATTR_USER , UBUS_ATTR_GROUP , UBUS_ATTR_MAX }
enum	ubus_monitor_attr {   UBUS_MONITOR_CLIENT , UBUS_MONITOR_PEER , UBUS_MONITOR_SEND , UBUS_MONITOR_SEQ ,   UBUS_MONITOR_TYPE , UBUS_MONITOR_DATA , UBUS_MONITOR_MAX }
enum	ubus_msg_status {   UBUS_STATUS_OK , UBUS_STATUS_INVALID_COMMAND , UBUS_STATUS_INVALID_ARGUMENT , UBUS_STATUS_METHOD_NOT_FOUND ,   UBUS_STATUS_NOT_FOUND , UBUS_STATUS_NO_DATA , UBUS_STATUS_PERMISSION_DENIED , UBUS_STATUS_TIMEOUT ,   UBUS_STATUS_NOT_SUPPORTED , UBUS_STATUS_UNKNOWN_ERROR , UBUS_STATUS_CONNECTION_FAILED , UBUS_STATUS_NO_MEMORY ,   UBUS_STATUS_PARSE_ERROR , UBUS_STATUS_SYSTEM_ERROR , __UBUS_STATUS_LAST }

Functions
struct ubus_msghdr	__attribute__ ((packed)) __attribute__((__aligned__(4)))

Variables
uint8_t	version
uint8_t	type
uint16_t	seq
uint32_t	peer
enum ubus_msg_type	__attribute__

Macro Definition Documentation

__packetdata

#define __packetdata   __attribute__((packed)) __attribute__((__aligned__(4)))

Definition at line 20 of file ubusmsg.h.

UBUS_MSG_CHUNK_SIZE

#define UBUS_MSG_CHUNK_SIZE   65536

Definition at line 22 of file ubusmsg.h.

UBUS_SYSTEM_OBJECT_ACL

#define UBUS_SYSTEM_OBJECT_ACL   2

Definition at line 25 of file ubusmsg.h.

UBUS_SYSTEM_OBJECT_EVENT

#define UBUS_SYSTEM_OBJECT_EVENT   1

Definition at line 24 of file ubusmsg.h.

UBUS_SYSTEM_OBJECT_MAX

#define UBUS_SYSTEM_OBJECT_MAX   1024

Definition at line 27 of file ubusmsg.h.

UBUS_SYSTEM_OBJECT_MONITOR

#define UBUS_SYSTEM_OBJECT_MONITOR   3

Definition at line 26 of file ubusmsg.h.

Enumeration Type Documentation

ubus_monitor_attr

enum ubus_monitor_attr

Enumerator
UBUS_MONITOR_CLIENT
UBUS_MONITOR_PEER
UBUS_MONITOR_SEND
UBUS_MONITOR_SEQ
UBUS_MONITOR_TYPE
UBUS_MONITOR_DATA
UBUS_MONITOR_MAX

Definition at line 106 of file ubusmsg.h.

                       {
        UBUS_MONITOR_CLIENT,
        UBUS_MONITOR_PEER,
        UBUS_MONITOR_SEND,
        UBUS_MONITOR_SEQ,
        UBUS_MONITOR_TYPE,
        UBUS_MONITOR_DATA,
 
        /* must be last */
        UBUS_MONITOR_MAX,
};

ubus_msg_attr

enum ubus_msg_attr

Enumerator
UBUS_ATTR_UNSPEC
UBUS_ATTR_STATUS
UBUS_ATTR_OBJPATH
UBUS_ATTR_OBJID
UBUS_ATTR_METHOD
UBUS_ATTR_OBJTYPE
UBUS_ATTR_SIGNATURE
UBUS_ATTR_DATA
UBUS_ATTR_TARGET
UBUS_ATTR_ACTIVE
UBUS_ATTR_NO_REPLY
UBUS_ATTR_SUBSCRIBERS
UBUS_ATTR_USER
UBUS_ATTR_GROUP
UBUS_ATTR_MAX

Definition at line 79 of file ubusmsg.h.

                   {
        UBUS_ATTR_UNSPEC,
 
        UBUS_ATTR_STATUS,
 
        UBUS_ATTR_OBJPATH,
        UBUS_ATTR_OBJID,
        UBUS_ATTR_METHOD,
 
        UBUS_ATTR_OBJTYPE,
        UBUS_ATTR_SIGNATURE,
 
        UBUS_ATTR_DATA,
        UBUS_ATTR_TARGET,
 
        UBUS_ATTR_ACTIVE,
        UBUS_ATTR_NO_REPLY,
 
        UBUS_ATTR_SUBSCRIBERS,
 
        UBUS_ATTR_USER,
        UBUS_ATTR_GROUP,
 
        /* must be last */
        UBUS_ATTR_MAX,
};

ubus_msg_status

enum ubus_msg_status

Enumerator
UBUS_STATUS_OK
UBUS_STATUS_INVALID_COMMAND
UBUS_STATUS_INVALID_ARGUMENT
UBUS_STATUS_METHOD_NOT_FOUND
UBUS_STATUS_NOT_FOUND
UBUS_STATUS_NO_DATA
UBUS_STATUS_PERMISSION_DENIED
UBUS_STATUS_TIMEOUT
UBUS_STATUS_NOT_SUPPORTED
UBUS_STATUS_UNKNOWN_ERROR
UBUS_STATUS_CONNECTION_FAILED
UBUS_STATUS_NO_MEMORY
UBUS_STATUS_PARSE_ERROR
UBUS_STATUS_SYSTEM_ERROR
__UBUS_STATUS_LAST

Definition at line 118 of file ubusmsg.h.

                     {
        UBUS_STATUS_OK,
        UBUS_STATUS_INVALID_COMMAND,
        UBUS_STATUS_INVALID_ARGUMENT,
        UBUS_STATUS_METHOD_NOT_FOUND,
        UBUS_STATUS_NOT_FOUND,
        UBUS_STATUS_NO_DATA,
        UBUS_STATUS_PERMISSION_DENIED,
        UBUS_STATUS_TIMEOUT,
        UBUS_STATUS_NOT_SUPPORTED,
        UBUS_STATUS_UNKNOWN_ERROR,
        UBUS_STATUS_CONNECTION_FAILED,
        UBUS_STATUS_NO_MEMORY,
        UBUS_STATUS_PARSE_ERROR,
        UBUS_STATUS_SYSTEM_ERROR,
        __UBUS_STATUS_LAST
};

ubus_msg_type

enum ubus_msg_type

Enumerator
UBUS_MSG_HELLO
UBUS_MSG_STATUS
UBUS_MSG_DATA
UBUS_MSG_PING
UBUS_MSG_LOOKUP
UBUS_MSG_INVOKE
UBUS_MSG_ADD_OBJECT
UBUS_MSG_REMOVE_OBJECT
UBUS_MSG_SUBSCRIBE
UBUS_MSG_UNSUBSCRIBE
UBUS_MSG_NOTIFY
UBUS_MSG_MONITOR
__UBUS_MSG_LAST

Definition at line 36 of file ubusmsg.h.

                   {
        /* initial server message */
        UBUS_MSG_HELLO,
 
        /* generic command response */
        UBUS_MSG_STATUS,
 
        /* data message response */
        UBUS_MSG_DATA,
 
        /* ping request */
        UBUS_MSG_PING,
 
        /* look up one or more objects */
        UBUS_MSG_LOOKUP,
 
        /* invoke a method on a single object */
        UBUS_MSG_INVOKE,
 
        UBUS_MSG_ADD_OBJECT,
        UBUS_MSG_REMOVE_OBJECT,
 
        /*
         * subscribe/unsubscribe to object notifications
         * The unsubscribe message is sent from ubusd when
         * the object disappears
         */
        UBUS_MSG_SUBSCRIBE,
        UBUS_MSG_UNSUBSCRIBE,
 
        /*
         * send a notification to all subscribers of an object.
         * when sent from the server, it indicates a subscription
         * status change
         */
        UBUS_MSG_NOTIFY,
 
        UBUS_MSG_MONITOR,
 
        /* must be last */
        __UBUS_MSG_LAST,
};

Function Documentation

__attribute__()

struct ubus_msghdr __attribute__

(

(packed)

)

Variable Documentation

__attribute__

enum ubus_msg_type __attribute__

peer

uint32_t peer

Definition at line 3 of file ubusmsg.h.

seq

uint16_t seq

Definition at line 2 of file ubusmsg.h.

type

uint8_t type

Definition at line 1 of file ubusmsg.h.

version

uint8_t version

Definition at line 0 of file ubusmsg.h.