Classes | Typedefs | Enumerations | Functions

hamcast::ipc Namespace Reference

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

Classes

class  channel
 An IPC channel. More...
class  client_channel
 An IPC channel describing the connection from a client to the middleware. More...
class  message
 Describes a single IPC message. More...
class  message_view
 Base class of all message views. More...
struct  sync_request_view
 A view for sync_request messages. More...
struct  sync_response_view
 A view for sync_response messages. More...
struct  async_send_view
 A view for async_send messages. More...
struct  async_recv_view
 A view for async_recv messages. More...
struct  cumulative_ack_view
 A view for cumulative_ack messages. More...
struct  retransmit_view
 A view for retransmit messages. More...
class  middleware_configuration
 Stores the configuration of the currently running middleware. More...

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 ()

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:
what An 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.
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator