GATE
SocopMaster Class Reference
Inheritance diagram for SocopMaster:
SocopDriver SocopServer gate::IRunnable socop_driver_class Socop Socop

Classes

struct  Resource
 

Public Types

typedef gate::Ref< ResourceResourceRef
 
- Public Types inherited from SocopDriver
typedef socop_read_byte_t Bytereader
 
typedef socop_write_byte_t Bytewriter
 
- Public Types inherited from Socop
enum  Result {
  Ok = SOCOP_OK , Error = SOCOP_ERROR , Error_NotImpl = SOCOP_ERROR_NOTIMPL , Error_IO = SOCOP_ERROR_IO ,
  Error_Timeout = SOCOP_ERROR_TIMEOUT , Error_InvalidData = SOCOP_ERROR_INVALIDDATA , Error_OutOfBounds = SOCOP_ERROR_OUTOFBOUNDS , Error_WrongMessage = SOCOP_ERROR_WRONGMESSAGE ,
  Error_ResourceError = SOCOP_ERROR_RESOURCEERROR , Error_Corruption = SOCOP_ERROR_CORRUPTION , Error_InvalidArg = SOCOP_ERROR_INVALIDARG , Error_Failed = SOCOP_ERROR_FAILED
}
 
enum  Flags { Flag_Receive = SOCOP_MSG_FLAG_RECV , Flag_Send = SOCOP_MSG_FLAG_SEND , Flag_Error = SOCOP_MSG_FLAG_ERROR }
 
typedef socop_socket_t Socket
 
typedef socop_addr_t Address
 
typedef socop_word_t word_t
 

Public Member Functions

bool start (gate::Stream &strm)
 
bool stop ()
 
- Public Member Functions inherited from SocopDriver
 SocopDriver (Bytereader reader_function, void *reader_param, Bytewriter writer_function, void *writer_param)
 
- Public Member Functions inherited from SocopServer
 SocopServer (SocopDriver const &driver)
 
void init (SocopDriver const &driver)
 
Result chat ()
 

Protected Member Functions

virtual Socop::Result do_read (unsigned char &received_byte, bool want_more)
 
virtual Socop::Result do_write (unsigned char byte_to_send, bool send_more)
 
virtual Socop::Result on_reset ()
 
virtual Socop::Result on_net_status ()
 
virtual Socop::Result on_net_start (char const *parameter, unsigned parameter_length)
 
virtual Socop::Result on_net_stop ()
 
virtual Socop::Result on_connect (Address const &addr, Socket &new_sock)
 
virtual Socop::Result on_bind (Address const &addr, Socket &new_sock)
 
virtual Socop::Result on_listen (Address const &addr, Socket &new_sock)
 
virtual Socop::Result on_accept (Socket listen_sock, Socket &new_sock)
 
virtual Socop::Result on_close (Socket sock)
 
virtual Socop::Result on_receive (Socket sock, void *buffer, unsigned buffer_length, unsigned &buffer_used)
 
virtual Socop::Result on_receive_from (Socket sock, void *buffer, unsigned buffer_length, unsigned &buffer_used, Address &addr)
 
virtual Socop::Result on_send (Socket sock, void const *buffer, unsigned buffer_length, unsigned &buffer_sent)
 
virtual Socop::Result on_send_to (Socket sock, void const *buffer, unsigned buffer_length, unsigned &buffer_sent, Address const &addr)
 
virtual Socop::Result on_shutdown (Socket sock, unsigned flags)
 
virtual Socop::Result on_select (Socket sock, unsigned &flags)
 
virtual Socop::Result on_peer (Socket sock)
 
virtual Socop::Result on_iocontrol (Socket sock)
 
virtual void run ()
 

Additional Inherited Members

- Public Attributes inherited from socop_driver_class
socop_read_byte_t read_byte
 
void * read_param
 
socop_write_byte_t write_byte
 
void * write_param
 
- Static Protected Member Functions inherited from SocopDriver
static int do_read_dispatcher (unsigned char *num, unsigned want_more, void *user_param)
 
static int do_write_dispatcher (unsigned char num, unsigned send_more, void *user_param)
 
- Static Protected Member Functions inherited from Socop
static Result translate_result (int result)
 
static int translate_result (Result result)
 

Member Function Documentation

◆ do_read()

Socop::Result SocopMaster::do_read ( unsigned char & received_byte,
bool want_more )
protectedvirtual

Reimplemented from SocopDriver.

◆ do_write()

Socop::Result SocopMaster::do_write ( unsigned char byte_to_send,
bool send_more )
protectedvirtual

Reimplemented from SocopDriver.

◆ on_accept()

Socop::Result SocopMaster::on_accept ( Socket listen_sock,
Socket & new_sock )
protectedvirtual

Implements SocopServer.

◆ on_bind()

Socop::Result SocopMaster::on_bind ( Address const & addr,
Socket & new_sock )
protectedvirtual

Implements SocopServer.

◆ on_close()

Socop::Result SocopMaster::on_close ( Socket sock)
protectedvirtual

Implements SocopServer.

◆ on_connect()

Socop::Result SocopMaster::on_connect ( Address const & addr,
Socket & new_sock )
protectedvirtual

Implements SocopServer.

◆ on_iocontrol()

Socop::Result SocopMaster::on_iocontrol ( Socket sock)
protectedvirtual

Implements SocopServer.

◆ on_listen()

Socop::Result SocopMaster::on_listen ( Address const & addr,
Socket & new_sock )
protectedvirtual

Implements SocopServer.

◆ on_net_start()

Socop::Result SocopMaster::on_net_start ( char const * parameter,
unsigned parameter_length )
protectedvirtual

Implements SocopServer.

◆ on_net_status()

Socop::Result SocopMaster::on_net_status ( )
protectedvirtual

Implements SocopServer.

◆ on_net_stop()

Socop::Result SocopMaster::on_net_stop ( )
protectedvirtual

Implements SocopServer.

◆ on_peer()

Socop::Result SocopMaster::on_peer ( Socket sock)
protectedvirtual

Implements SocopServer.

◆ on_receive()

Socop::Result SocopMaster::on_receive ( Socket sock,
void * buffer,
unsigned buffer_length,
unsigned & buffer_used )
protectedvirtual

Implements SocopServer.

◆ on_receive_from()

Socop::Result SocopMaster::on_receive_from ( Socket sock,
void * buffer,
unsigned buffer_length,
unsigned & buffer_used,
Address & addr )
protectedvirtual

Implements SocopServer.

◆ on_reset()

Socop::Result SocopMaster::on_reset ( )
protectedvirtual

Implements SocopServer.

◆ on_select()

Socop::Result SocopMaster::on_select ( Socket sock,
unsigned & flags )
protectedvirtual

Implements SocopServer.

◆ on_send()

Socop::Result SocopMaster::on_send ( Socket sock,
void const * buffer,
unsigned buffer_length,
unsigned & buffer_sent )
protectedvirtual

Implements SocopServer.

◆ on_send_to()

Socop::Result SocopMaster::on_send_to ( Socket sock,
void const * buffer,
unsigned buffer_length,
unsigned & buffer_sent,
Address const & addr )
protectedvirtual

Implements SocopServer.

◆ on_shutdown()

Socop::Result SocopMaster::on_shutdown ( Socket sock,
unsigned flags )
protectedvirtual

Implements SocopServer.

◆ run()

void SocopMaster::run ( )
protectedvirtual

Implements gate::IRunnable.


The documentation for this class was generated from the following files: