(:redirect Documentation.Interface-Binary-2-2 quiet=1:)

In order to send or listen for Binary Packets, an interface must be specified using the bin_listen global script parameter. The number of listener processes can be tuned with the optional bin_children (default: 1)

In order to send or listen for Binary Packets, an interface must be specific using the bin_listen global script parameter. The number of listener processes can be tuned with the optional bin_children (default: 1)

   modparam("dialog", "replicate_dialogs_to", "78.46.64.50:5062")

• int bin_init(str *mod_name, int packet_type) - begins the contruction of a new Binary Packet

Configuring the Binary Internal Interface listeners

The interface allows the module writer to build and send compact Binary Packets in an intuitive way.

In order to send packets the interface provides the following primitives:

• int bin_register_cb(char *mod_name, void (*)(int packet_type)) - begins the contruction of a new Binary Packet
• int bin_push_str(const str *info) - add a string to the Binary Packet that is currently being built
• int bin_push_int(int info) - add an integer to the Binary Packet that is currently being built
• int bin_send(union sockaddr_union *dest) - sends the Binary Packet to a given destination over UDP

In order to receive packets, a module must first register a callback function to the interface:

• int bin_register_cb(char *mod_name, void (*)(int packet_type))

Each time the callback is triggered, the information can be retrieved in the same order it was written using:

• int bin_pop_str(str *info) - retrieve a string from a received Binary Packet
• int bin_pop_int(void *info) - retrive an integer from a received Binary Packet

C Interface Overview (for module developers)

Configuring the Binary Internal Interface

In order to send or listen for Binary Packets, a interface must be specific using the bin_listen global script parameter. The number of listener processes can be tuned with the optional bin_children (default: 1)

C Interface Overview

In order to define an UDP listening interface for incoming Binary Packets, the bin_listen global script parameter must be defined. The number of listener processes can be increased with the optional bin_children (default: 1)

Currently, the only module to make use of the interface is the dialog module, which can now replicate all dialog-related events to one or more OpenSIPS instances. Configuration can be done as follows:

   modparam("dialog", "accept_replicated_dialogs", 1)
   modparam("dialog", "replicate_dialogs_to", "192.168.2.102:5062")

More details can be found in the documentation page of the module.

Overview

The interface allows the module writer to build and send compact Binary Packets in an intuitive way. This can be done using the following functions:

• bin_init - begins the contruction of a new Binary Packet
• bin_push_{str, int} - add information to the Binary Packet that is currently being built
• bin_send - sends the Binary Packet to a given destination over UDP

Individual modules can register to the interface using:

• bin_register_cb

When packets are received, the module-specific callback functions are triggered. Information can now be retrieved with:

• bin_pop_{str, int} - extract information from a received Info Packet in the same order it was written

In order to listen for incoming Binary Packets, the bin_listen global script parameter must be defined. The number of listener processes can be increased with the optional bin_children (default: 1)

In order to listen for incoming Binary Packets, the bin_listen global script parameter must be defined. Moreover, the number of listener processes can be increased with the optional bin_children (default: 1)

   bin_children = 2

The Binary Internal Interface is an OpenSIPS core interface which offers an efficient way for communication between individual OpenSIPS instances. This is especially useful in scenarios where realtime data (such as dialogs) cannot be simply stored in a database anymore, because failover would require entire minutes to complete. This issue can be solved with the new internal binary interface by replicating all the events related to the runtime data (creation / updating / deletion) to a backup OpenSIPS instance.

The Binary Internal Interface is an OpenSIPS core interface which offers an efficient way for communication between individual OpenSIPS instances. This is especially useful in scenarios where realtime data (such as dialogs) cannot be simply stored in a database anymore, because failover would require entire minutes to complete. This issue can be solved with the Binary Interface by replicating all the events related to the runtime data (creation / updating / deletion) to a backup OpenSIPS instance.

Documentation -> Manuals -> Manual devel -> Binary Internal Interface

(:title Binary Internal Interface - devel :)

   bin_children = 2 # optional

• bin_register_cb

• bin_pop_{str, int} - extract information from a received Info Packet in the same order it was written

The interface allows the module writer to build and send compact Binary Packets in an intuitive way. This can be done using the following functions:

Individual modules can register to the interface using:

• register_bin_cb

When packets are received, the module-specific callback functions are triggered. Information can now be retrieved with:

• info_packet_pop_{str, int} - extract information from a received Info Packet in the same order it was written

Currently, the only module to make use of the interface is the dialog module, which can now replicate all dialog-related events to one or more OpenSIPS instances.

Documentation -> Manuals -> Manual devel -> Binary Interface

(:title Binary Interface - devel :)

Page for other versions: devel 1.9 1.8 old versions: 1.7 1.6 1.5 1.4

The Binary Interface is an OpenSIPS core interface which offers an efficient way for communication between individual OpenSIPS instances. This is especially useful in scenarios where realtime data (such as dialogs) cannot be simply stored in a database anymore, because failover would require entire minutes to complete. This issue can be solved with the Binary Interface by replicating all the events related to the runtime data (creation / updating / deletion) to a backup OpenSIPS instance.

Overview

The interface allows the module writer to build compact Binary Packets in an intuitive way. It exports the following functions:

• bin_init - begins the contruction of a new Binary Packet
• bin_push_{str, int} - add information to the Binary Packet that is currently being built
• bin_send - sends the Binary Packet to a given destination over UDP
• bin_pop_{str, int} - extract information from a received Binary Packet in the same order it was written

Usage

In order to listen for incoming Binary Packets, the following global script parameters must be configured:

   bin_listen = 10.0.0.150:5062
   bin_children  = 2 # optional

Currently, the only module to make use of the interface is the dialog module, which can now replicate all dialog-related events to one or more OpenSIPS instances.