Spread 4.0.0 C API

Topic
Function
Description
Core API SP_connect create a connection to a Spread network
  SP_disconnect disconnect a connection to a Spread network
  SP_kill close a connection locally without signalling the daemon
  SP_join join a group
  SP_leave leave a group
  SP_multicast send a message
  SP_multigroup_multicast send a message to multiple groups
  SP_scat_multicast send a message using a scatter message structure
  SP_multigroup_scat_multicast send a message to multiple groups using a scatter message structure
  SP_receive receive a message
  SP_scat_receive receive a message into a scatter structure
     
Supporting API SP_poll queries a Spread connection to see if any messages are available to receive
  SP_get_memb_info extract and parse the membership info from a membership message
  SP_scat_get_memb_info extract and parse the membership info from a scatter membership message
  SP_get_vs_sets_info extract list of vs_sets from membership message
  SP_scat_get_vs_sets_info extract list of vs_sets from scatter membership message
  SP_get_vs_set_members extract and copy members of a specified vs_set from a membership message
  SP_scat_get_vs_set_members extract and copy members of a specified vs_set from a scatter membership message
  SP_error prints to stdout a text string describing a Spread returned error code
  SP_equal_group_ids tests the equality of two group ids
  SP_version returns the current Spread library version being used
  Message Service Type Access Functions Macro functions used to determine the message type (membership or data) and the specific service type
     
Authentication SP_set_auth_method See: Framework for Authentication and Access Control of Client-Server Group Communication Systems
  SP_set_auth_methods See: Framework for Authentication and Access Control of Client-Server Group Communication Systems
     
Executables spread (daemon) Multicast group communication daemon
  spuser Spread group communication client
  spflooder Spread performance test client
  spmonitor Spread monitoring and administration client
  libspread (library) Spread group communication client library
     
Sample Programs user.c Terminal program that allows one to join and leave groups, send several types of messages and see how membership changes. It uses all the Spread calls.
  monitor.c Terminal program that allows the user to monitor any active Spread daemon and check the state of messages as well as artificially creating network partitions or tuning the daemon for your network.
  flooder.c Test program that sends a stream of messages of specified size and type to Spread and receives them while calculating some performance measurements.
     
Other Endian Conversion Utility routines for endian correction
  Events Interface Event library is a utility library provided with Spread, but it is not required that you use it. It is simply provided to avoid everyone having to write their own event handling system.
  Message Types Message types that can be sent and received by Spread
  Return Codes Error codes returned by Spread functions
  C structures Types Used in Function Prototypes