OpenSDN source code
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
TcpSession::Reader Class Reference
Inheritance diagram for TcpSession::Reader:
Collaboration diagram for TcpSession::Reader:

Public Types

typedef function< void(Buffer)> ReadHandler
 
- Public Types inherited from Task
enum  State { INIT, WAIT, RUN }
 Task states. More...
 
enum  TbbState { TBB_INIT, TBB_ENQUEUED, TBB_EXEC, TBB_DONE }
 

Public Member Functions

 Reader (TcpSessionPtr session, ReadHandler read_fn, Buffer buffer)
 
virtual bool Run ()
 Code to execute. Returns true if task is completed. Return false to reschedule the task. More...
 
string Description () const
 
- Public Member Functions inherited from Task
 Task (int task_id, int task_instance)
 
 Task (int task_id)
 
virtual ~Task ()
 
virtual void OnTaskCancel ()
 Called on task exit, if it is marked for cancellation. If the user wants to do any cleanup on task cancellation, then he/she can overload this function. More...
 
State GetState () const
 
int GetTaskId () const
 
int GetTaskInstance () const
 
uint64_t GetSeqno () const
 
bool task_cancelled () const
 
uint64_t enqueue_time () const
 
uint64_t schedule_time () const
 
uint32_t execute_delay () const
 
uint32_t schedule_delay () const
 

Private Attributes

TcpSessionPtr session_
 
ReadHandler read_fn_
 
Buffer buffer_
 

Additional Inherited Members

- Static Public Member Functions inherited from Task
static TaskRunning ()
 Returns a pointer to the current task the code is executing under. More...
 
- Static Public Attributes inherited from Task
static const int kTaskInstanceAny = -1
 

Detailed Description

Definition at line 56 of file tcp_session.cc.

Member Typedef Documentation

typedef function<void(Buffer)> TcpSession::Reader::ReadHandler

Definition at line 58 of file tcp_session.cc.

Constructor & Destructor Documentation

TcpSession::Reader::Reader ( TcpSessionPtr  session,
ReadHandler  read_fn,
Buffer  buffer 
)
inline

Definition at line 60 of file tcp_session.cc.

Member Function Documentation

string TcpSession::Reader::Description ( ) const
inlinevirtual

Implements Task.

Definition at line 78 of file tcp_session.cc.

virtual bool TcpSession::Reader::Run ( )
inlinevirtual

Code to execute. Returns true if task is completed. Return false to reschedule the task.

Implements Task.

Definition at line 64 of file tcp_session.cc.

Here is the call graph for this function:

Member Data Documentation

Buffer TcpSession::Reader::buffer_
private

Definition at line 83 of file tcp_session.cc.

ReadHandler TcpSession::Reader::read_fn_
private

Definition at line 82 of file tcp_session.cc.

TcpSessionPtr TcpSession::Reader::session_
private

Definition at line 81 of file tcp_session.cc.


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