OpenSDN source code
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
contrail::sandesh::transport::TTransportDefaults Class Reference

#include <TVirtualTransport.h>

Inheritance diagram for contrail::sandesh::transport::TTransportDefaults:
Collaboration diagram for contrail::sandesh::transport::TTransportDefaults:

Public Member Functions

uint32_t read (uint8_t *buf, uint32_t len)
 
uint32_t readAll (uint8_t *buf, uint32_t len)
 
int write (const uint8_t *buf, uint32_t len)
 
const uint8_t * borrow (uint8_t *buf, uint32_t *len)
 
void consume (uint32_t len)
 
- Public Member Functions inherited from contrail::sandesh::transport::TTransport
virtual ~TTransport ()
 
virtual bool isOpen ()
 
virtual bool peek ()
 
virtual void open ()
 
virtual void close ()
 
int32_t read (uint8_t *buf, uint32_t len)
 
virtual int32_t read_virt (uint8_t *, uint32_t)
 
int32_t readAll (uint8_t *buf, uint32_t len)
 
virtual int32_t readAll_virt (uint8_t *buf, uint32_t len)
 
virtual uint32_t readEnd ()
 
int write (const uint8_t *buf, uint32_t len)
 
virtual int write_virt (const uint8_t *, uint32_t)
 
virtual uint32_t writeEnd ()
 
virtual void flush ()
 
const uint8_t * borrow (uint8_t *buf, uint32_t *len)
 
virtual const uint8_t * borrow_virt (uint8_t *, uint32_t *)
 
void consume (uint32_t len)
 
virtual void consume_virt (uint32_t)
 

Protected Member Functions

 TTransportDefaults ()
 
- Protected Member Functions inherited from contrail::sandesh::transport::TTransport
 TTransport ()
 

Detailed Description

Helper class that provides default implementations of TTransport methods.

This class provides default implementations of read(), readAll(), write(), borrow() and consume().

In the TTransport base class, each of these methods simply invokes its virtual counterpart. This class overrides them to always perform the default behavior, without a virtual function call.

The primary purpose of this class is to serve as a base class for TVirtualTransport, and prevent infinite recursion if one of its subclasses does not override the TTransport implementation of these methods. (Since TVirtualTransport::read_virt() calls read(), and TTransport::read() calls read_virt().)

Definition at line 44 of file TVirtualTransport.h.

Constructor & Destructor Documentation

contrail::sandesh::transport::TTransportDefaults::TTransportDefaults ( )
inlineprotected

Definition at line 67 of file TVirtualTransport.h.

Member Function Documentation

const uint8_t* contrail::sandesh::transport::TTransportDefaults::borrow ( uint8_t *  buf,
uint32_t *  len 
)
inline

Definition at line 59 of file TVirtualTransport.h.

Here is the call graph for this function:

void contrail::sandesh::transport::TTransportDefaults::consume ( uint32_t  len)
inline

Definition at line 62 of file TVirtualTransport.h.

Here is the call graph for this function:

uint32_t contrail::sandesh::transport::TTransportDefaults::read ( uint8_t *  buf,
uint32_t  len 
)
inline

Definition at line 50 of file TVirtualTransport.h.

Here is the call graph for this function:

uint32_t contrail::sandesh::transport::TTransportDefaults::readAll ( uint8_t *  buf,
uint32_t  len 
)
inline

Definition at line 53 of file TVirtualTransport.h.

Here is the call graph for this function:

int contrail::sandesh::transport::TTransportDefaults::write ( const uint8_t *  buf,
uint32_t  len 
)
inline

Definition at line 56 of file TVirtualTransport.h.

Here is the call graph for this function:


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