hamcast  Version 0.7
Classes | Typedefs | Enumerations | Functions
hamcast::ipc Namespace Reference

Classes

class  channel
 
class  client_channel
 
class  message
 
class  message_view
 
struct  sync_request_view
 
struct  sync_response_view
 
struct  async_send_view
 
struct  async_recv_view
 
struct  cumulative_ack_view
 
struct  retransmit_view
 
class  middleware_configuration
 

Typedefs

typedef boost::uint32_t request_id
 
typedef boost::uint32_t sequence_number
 
typedef boost::uint16_t stream_id
 

Enumerations

enum  exception_id {
  eid_none = 0x0000,
  eid_requirement_failed = 0x0001,
  eid_internal_interface_error = 0x0002
}
 
enum  function_id {
  fid_create_socket = 0x0001,
  fid_delete_socket = 0x0002,
  fid_create_send_stream = 0x0003
}
 
enum  message_type {
  sync_request = 0x00,
  sync_response = 0x01,
  async_event = 0x02,
  async_send = 0x03,
  async_recv = 0x04,
  cumulative_ack = 0x05,
  retransmit = 0x06
}
 

Functions

bool valid (message_type what)
 
socket_id create_socket ()
 
void delete_socket (socket_id sid)
 
stream_id create_send_stream (socket_id sid, const uri &group)
 
void join (socket_id sid, const uri &group)
 
void leave (socket_id sid, const uri &group)
 
void set_ttl (socket_id sid, boost::uint8_t value)
 
std::vector< interface_idget_sock_interfaces (socket_id sid)
 
void add_sock_interface (socket_id sid, interface_id iid)
 
void del_sock_interface (socket_id sid, interface_id iid)
 
void set_sock_interfaces (socket_id sid, const std::vector< interface_id > &ifs)
 
std::vector< interface_propertyget_interfaces ()
 
std::vector< std::pair< uri,
boost::uint32_t > > 
group_set (interface_id iid)
 
std::vector< urineighbor_set (interface_id iid)
 
std::vector< urichildren_set (interface_id iid, const uri &group)
 
std::vector< uriparent_set (interface_id iid, const uri &group)
 
bool designated_host (interface_id iid, const uri &group)
 
void enable_events ()
 
void disable_events ()
 
boost::uint32_t get_atomic_msg_size (interface_id iid)
 

Detailed Description

This namespace contains all IPC related parts of the HAMcast library.

Function Documentation

bool hamcast::ipc::valid ( message_type  what)

Check if what is a valid message type.

Parameters
whatAn integer value interpreted as message_type.
Returns
true if what has a valid value; otherwise false.
Note
This function is used to verify, that a cast from an integer value to message_type results in a valid expression.