S3FC project page S3FC home page
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

s3_txport_event Struct Reference

Event type for the s3_txport system. More...

#include <s3_txport_base.h>

List of all members.

Public Types

enum  event_type {
  connect, disconnect, metadata, error,
  information, reject, null_event
}
 Event types generated by the txport mechanisms. More...


Public Methods

 s3_txport_event (event_type e, s3_txport_client_id a_id, const std::string &m)
 Constructor builds all this from scratch. More...

 s3_txport_event ()

Public Attributes

event_type event
 Enumeration of the event type. More...

s3_txport_client_id id
 Client ID that generated the event. More...

std::string message
 Message string associated with the event. More...

Detailed Description

Event type for the s3_txport system.

This structure will contain all the information pertinent to the event that has been generated. The handler must mask the event it requires and react accordingly.

Definition at line 131 of file s3_txport_base.h.

Member Enumeration Documentation

enum s3_txport_event::event_type
 

Event types generated by the txport mechanisms.

Enumeration values:
connect  Remote connection received event.
disconnect  Remote instance disconnected.
metadata  Metadata has been received for this ID, the data is in the message string.
error  Error received in the txport.
information  Informational message.
reject  Rejected connection.
null_event  Uninitialized or NULL event.

Definition at line 134 of file s3_txport_base.h.

Referenced by s3_txport_event.

Constructor & Destructor Documentation

s3_txport_event::s3_txport_event (  event_type    e,
s3_txport_client_id    a_id,
const std::string &    m
)  [inline]
 

Constructor builds all this from scratch.

Definition at line 159 of file s3_txport_base.h.

References event, event_type, id, message, and s3_txport_client_id.

s3_txport_event::s3_txport_event (    )  [inline]
 

Definition at line 162 of file s3_txport_base.h.

References event, id, message, and null_event.

Member Data Documentation

event_type s3_txport_event::event
 

Enumeration of the event type.

Definition at line 153 of file s3_txport_base.h.

Referenced by s3_post_office_switch::handle_transport_events, and s3_txport_event.

s3_txport_client_id s3_txport_event::id
 

Client ID that generated the event.

Definition at line 155 of file s3_txport_base.h.

Referenced by s3_post_office_switch::handle_transport_events, and s3_txport_event.

std::string s3_txport_event::message
 

Message string associated with the event.

Definition at line 157 of file s3_txport_base.h.

Referenced by s3_txport_event.

The documentation for this struct was generated from the following file:
Send comments to: s3fc@stonethree.com SourceForge Logo