|
Line 0
Link Here
|
|
|
1 |
This is a C++ single class library encapsulating a protocol conduit. The |
| 2 |
premise is that there is a local network over which to multicast Bible |
| 3 |
navigation, and someone, possibly several someones, will transmit, and others |
| 4 |
will receive. The choices for when you decide to xmit and what to do when you |
| 5 |
recv are up to you as the application designer. |
| 6 |
|
| 7 |
Access to the conduit is by creating the object, setting the mode, calling |
| 8 |
Transmit() to xmit nav events, and arranging the frequent polling of Receive() |
| 9 |
to recv nav events. There is more than just navigation to be handled; there |
| 10 |
are live/dead events for potential Speakers as well as mismatches, presence |
| 11 |
announcements, and errors. There is a programming reference biblesync.7 which |
| 12 |
explains the details, both from a high level view of the essentials of the |
| 13 |
protocol's behavior and at a low level of how you create, access, and use the |
| 14 |
conduit class. The (single) BibleSync object should persist throughout the |
| 15 |
life of your application, but at any time you can set the mode to "disable," |
| 16 |
and preferably stop the receive polling, and then re-enable it later as the |
| 17 |
user needs. |
| 18 |
|
| 19 |
Much work has been done in integrating this library into its first application, |
| 20 |
Xiphos. It is useful to examine Xiphos' code to see where and how integration |
| 21 |
has been done. Get a Xiphos source tree using: |
| 22 |
git clone https://github.com/crosswire/xiphos |
| 23 |
|
| 24 |
WWW: https://github.com/karlkleinpaste/biblesync |