Trippin Cyril
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | List of all members
trippingcyril::Pipe Class Referenceabstract

A wrapper class for pipes. More...

#include <Pipe.h>

Inheritance diagram for trippingcyril::Pipe:
[legend]
Collaboration diagram for trippingcyril::Pipe:
[legend]

Public Member Functions

 Pipe (const Module *pModule=NULL)
 
virtual ~Pipe ()
 
int Read (char *buffer, size_t len)
 
int Write (const char *buffer, size_t len) override
 
- Public Member Functions inherited from trippingcyril::trippingcyril::Event
 Event (const Module *module)
 
virtual ~Event ()
 
const ModuleGetModule () const
 
- Public Member Functions inherited from trippingcyril::Writer
int WriteString (const String &data)
 
virtual bool shouldDelete () const override
 

Protected Member Functions

virtual void OnRead ()=0
 
- Protected Member Functions inherited from trippingcyril::trippingcyril::Event
event_base * GetEventBase () const
 
evdns_base * GetDNSBase () const
 

Additional Inherited Members

- Static Public Attributes inherited from trippingcyril::Writer
static const int BUFFER_SIZE
 
- Protected Attributes inherited from trippingcyril::trippingcyril::Event
const Modulemodule
 

Detailed Description

A wrapper class for pipes.

Constructor & Destructor Documentation

trippingcyril::Pipe::Pipe ( const Module pModule = NULL)

General constructor

Parameters
pModuleThe module to register this pipe on
Exceptions
std::runtime_errorIf the pipe() system call failed
virtual trippingcyril::Pipe::~Pipe ( )
virtual

Deconstructor, will close both ends of the pipe

Member Function Documentation

virtual void trippingcyril::Pipe::OnRead ( )
protectedpure virtual

Override this method with your own stuff to do when read operations happen

int trippingcyril::Pipe::Read ( char *  buffer,
size_t  len 
)
inline

Generic read operation from this pipe, similar to read(2)

int trippingcyril::Pipe::Write ( const char *  buffer,
size_t  len 
)
inlineoverridevirtual

Generic write operation to this pipe, similar to write(2)

Implements trippingcyril::Writer.


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