The back-end interface structure. More...
#include <amxb_be_intf.h>
Detailed Description
The back-end interface structure.
Each back-end must provide exactly one instance of this structure.
All mandatory function pointers must be set to a valid function, and must match the function signature as defined.
Optional functions may be set to NULL pointer.
Definition at line 1735 of file amxb_be_intf.h.
Field Documentation
◆ accept
| amxb_be_accept_fn_t _amxb_be_funcs::accept |
Mandatory when listen is set, otherwise optional: accepts or drops incoming connections, see amxb_be_accept_fn_t
Definition at line 1764 of file amxb_be_intf.h.
◆ add
| amxb_be_add_t _amxb_be_funcs::add |
Optional: Performs USP like add operator on data model, see amxb_be_add_t
Definition at line 1757 of file amxb_be_intf.h.
◆ async_invoke
| amxb_be_async_invoke_fn_t _amxb_be_funcs::async_invoke |
Optional: Calls a RPC method and returns immediately, see amxb_be_invoke_fn_t
Definition at line 1748 of file amxb_be_intf.h.
◆ capabilities
| amxb_be_capabilities_fn_t _amxb_be_funcs::capabilities |
Definition at line 1767 of file amxb_be_intf.h.
◆ close_request
| amxb_be_close_request_fn_t _amxb_be_funcs::close_request |
Optional: Closes or cancels a pending async RPC, see amxb_be_close_request_fn_t
Definition at line 1749 of file amxb_be_intf.h.
◆ connect
| amxb_be_connect_fn_t _amxb_be_funcs::connect |
Mandatory: Opens a bus connection or connects to a socket, see amxb_be_connect_fn_t
Definition at line 1741 of file amxb_be_intf.h.
◆ connections
| amxc_llist_t _amxb_be_funcs::connections |
Reserved for internal use only
Definition at line 1738 of file amxb_be_intf.h.
◆ del
| amxb_be_del_t _amxb_be_funcs::del |
Optional: Performs USP like del operator on data model, see amxb_be_del_t
Definition at line 1758 of file amxb_be_intf.h.
◆ describe
| amxb_be_describe_t _amxb_be_funcs::describe |
Definition at line 1761 of file amxb_be_intf.h.
◆ disconnect
| amxb_be_disconnect_fn_t _amxb_be_funcs::disconnect |
Mandatory: Closes a bus connection or disconnects from a socket, see amxb_be_disconnect_fn_t
Definition at line 1742 of file amxb_be_intf.h.
◆ free
| amxb_be_free_fn_t _amxb_be_funcs::free |
Mandatory: Frees allocated memory for a bus connection, see amxb_be_free_fn_t
Definition at line 1753 of file amxb_be_intf.h.
◆ free_invoke
| amxb_be_free_invoke_fn_t _amxb_be_funcs::free_invoke |
Mandatory if new_invoke is implemented and allocates memory: frees memory allocated by new_invoke implementation
Definition at line 1746 of file amxb_be_intf.h.
◆ get
| amxb_be_get_t _amxb_be_funcs::get |
Optional: Performs USP like get operator on data model, see amxb_be_get_t
Definition at line 1755 of file amxb_be_intf.h.
◆ get_fd
| amxb_be_get_fd_fn_t _amxb_be_funcs::get_fd |
Mandatory: Returns the file descriptor that needs to be monitored, see amxb_be_get_fd_fn_t
Definition at line 1743 of file amxb_be_intf.h.
◆ get_filtered
| amxb_be_get_filtered_t _amxb_be_funcs::get_filtered |
Optional: Performs a filtered get, if not available the normal get is used
Definition at line 1770 of file amxb_be_intf.h.
◆ get_instances
| amxb_be_get_instances_t _amxb_be_funcs::get_instances |
Optional: Performs USP like get instances operator on data model, see amxb_be_get_instances_t
Definition at line 1769 of file amxb_be_intf.h.
◆ get_supported
| amxb_be_get_supported_t _amxb_be_funcs::get_supported |
Optional: Performs USP like get supported data model operator, see amxb_be_get_supported_t
Definition at line 1759 of file amxb_be_intf.h.
◆ handle
| void* _amxb_be_funcs::handle |
Reserved for internal use only
Definition at line 1737 of file amxb_be_intf.h.
◆ has
| amxb_be_has_fn_t _amxb_be_funcs::has |
Definition at line 1768 of file amxb_be_intf.h.
◆ invoke
| amxb_be_invoke_fn_t _amxb_be_funcs::invoke |
Mandatory: Calls a RPC method and waits for result, see amxb_be_invoke_fn_t
Definition at line 1747 of file amxb_be_intf.h.
◆ it
| amxc_htable_it_t _amxb_be_funcs::it |
Reserved for internal use only
Definition at line 1736 of file amxb_be_intf.h.
◆ list
| amxb_be_list_t _amxb_be_funcs::list |
Definition at line 1762 of file amxb_be_intf.h.
◆ listen
| amxb_be_listen_fn_t _amxb_be_funcs::listen |
Optional: Creates a listen socket, see amxb_be_listen_fn_t
Definition at line 1763 of file amxb_be_intf.h.
◆ name
| const char* _amxb_be_funcs::name |
The back-end name, used as identifier, must be unique
Definition at line 1739 of file amxb_be_intf.h.
◆ new_invoke
| amxb_be_new_invoke_fn_t _amxb_be_funcs::new_invoke |
Optional: Updates the invoke data,
- See also
- amxb_be_new_invoke_fn_t
Definition at line 1745 of file amxb_be_intf.h.
◆ read
| amxb_be_read_fn_t _amxb_be_funcs::read |
Mandatory: Reads incoming messages and handle them, see amxb_be_read_fn_t
Definition at line 1744 of file amxb_be_intf.h.
◆ read_raw
| amxb_be_read_raw_fn_t _amxb_be_funcs::read_raw |
Definition at line 1765 of file amxb_be_intf.h.
◆ register_dm
| amxb_be_register_fn_t _amxb_be_funcs::register_dm |
Optional: Registers an ambiorix data model to the bus system, see amxb_be_register_fn_t
Definition at line 1754 of file amxb_be_intf.h.
◆ set
| amxb_be_set_t _amxb_be_funcs::set |
Optional: Performs USP like set operator on data model, see amxb_be_set_t
Definition at line 1756 of file amxb_be_intf.h.
◆ set_config
| amxb_be_set_config_t _amxb_be_funcs::set_config |
Optional: Makes it possible to pass configuration options to the back-end, see amxb_be_set_config_t
Definition at line 1760 of file amxb_be_intf.h.
◆ size
| size_t _amxb_be_funcs::size |
The size of the structure, must be set to sizeof(amxb_be_funcs_t)
Definition at line 1740 of file amxb_be_intf.h.
◆ subscribe
| amxb_be_subscribe_fn_t _amxb_be_funcs::subscribe |
Optional: Creates/opens a subscription for receiving events/notifications, see amxb_be_subscribe_fn_t
Definition at line 1751 of file amxb_be_intf.h.
◆ unsubscribe
| amxb_be_unsubscribe_fn_t _amxb_be_funcs::unsubscribe |
Optional: Removes/closes a subscription, see amxb_be_unsubscribe_fn_t
Definition at line 1752 of file amxb_be_intf.h.
◆ wait_for
| amxb_be_wait_for_fn_t _amxb_be_funcs::wait_for |
Definition at line 1766 of file amxb_be_intf.h.
◆ wait_request
| amxb_be_wait_request_fn_t _amxb_be_funcs::wait_request |
Optional: Wait for async RPC to complete, see amxb_be_wait_request_fn_t
Definition at line 1750 of file amxb_be_intf.h.
The documentation for this struct was generated from the following file:
- include/amxb/amxb_be_intf.h
