|Binary Internal Interface v3.0|
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.
In order to listen for incoming Binary Packets, a bin: interface must be specified. Its number of listener processes can be tuned with tcp_children (default: 8)
listen = bin:10.0.0.150:5062 ... loadmodule "proto_bin.so"
Examples of cluster-enabled modules which use the binary interface are dialog and usrloc, as they can now replicate all run-time events (creation/updating/deletion of dialogs/contacts) to one or more OpenSIPS instances. Configuration can be done as follows:
modparam("dialog", "dialog_replication_cluster", 1) modparam("dialog", "profile_replication_cluster", 2) ... modparam("usrloc", "location_cluster", 2)
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:
In order to receive packets, a module must first register a callback function to the interface:
Each time this callback is triggered, the information can be retrieved in the same order it was written using: