beepcore-c

C/C++ BEEP project hosted on

Manual Entries

BEEP is a P2P application protocol framework for connection-oriented, asychonous interctions. BEEP permits simultaneous and independent exchanges within the context of a single application user-identity, supporting both textual and binary messages.

You're looking at the home of the documentation for beepcore-c, which implements BEEP in C/C++. Useful links:

• BEEP community website (highly recommended)
• Sourceforge project page
• CVS web interface
• How to get the source tree via CVS:
  

      cvs -z3 \
        -d:pserver:anonymous@cvs.beepcore-c.sourceforge.net:/cvsroot/beepcore-c \
        login
  
      cvs -z3 \
        -d:pserver:anonymous@cvs.beepcore-c.sourceforge.net:/cvsroot/beepcore-c \
        co beepcore-tcl
  

• Mailing lists: announcements, cvs commits, and users
• Documentation: tgz file, or zip file.

First read the architectural overview, followed by the profile tutorial. Then consult these source files:

• profiles/null-profiles.h
• profiles/null-profiles.c
• threaded_os/examples/beepd.c
• threaded_os/examples/beepng.c

Because the manual entries are implicitly-based on the ordering of definitions in the source code, it may not intuitive to use the hierarchy it presents. So, we've provided both an alphabetic index of structures and functions, along with this perspective:

• Library Initialization
• Profile Module Management:
• PROFILE_REGISTRATION structure
• Functions
• Connection Management:
• BP_CONNECTION structure
• General Functions
• Convenience functions for TCP-based connections
• Session Management
• Channel Management:
• PROFILE_INSTANCE structure
• CHANNEL_INSTANCE structure
• profile structure
• frame structure
• General Functions
• Buffer Management
• Frame Management
• Tuning Profile Magic
• Diagnostic Management:
• DIAGNOSTIC structure
• Functions
• Utility Functions:
• Configuration
• Logging
• Semaphores
• Threads
• Profiles:
• Tuning Parameters
• SASL ANONYMOUS and OTP
  Note well: the next major release of beepcore-c will remove support for the home-grown OTP profile — instead, you'll need to use the Cyrus SASL profiles. Now would be a good time to familiarize yourself with Cyrus SASL.
• Cyrus SASL
• TLS
• NULL ECHO/SINK
• SYSLOG reliable RAW

Home Alphabetic index