class SocketFilter

A filter for received socket data. More...

Contains pure virtuals
Full nameTelEngine::SocketFilter
Definition#include <yateclass.h>
InheritsTelEngine::GenObject [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods


Detailed Description

Abstract interface for an object that filters socket received data packets

 SocketFilter ()

SocketFilter

Constructor

 ~SocketFilter ()

~SocketFilter

[virtual]

Destructor, unregisters from socket

void*  getObject (const String& name)

getObject

[const virtual]

Get a pointer to a derived class given that class name

Parameters:
nameName of the class we are asking for

Returns: Pointer to the requested class or NULL if this object doesn't implement it

Reimplemented from GenObject.

void  timerTick (const Time& when)

timerTick

[virtual]

Run whatever actions required on idle thread runs

Parameters:
whenTime when the idle run started

bool  received (void* buffer, int length, int flags, const struct sockaddr* addr, socklen_t adrlen)

received

[pure virtual]

Notify this filter about a received block of data

Parameters:
bufferBuffer for received data
lengthLength of the data in buffer
flagsOperating system specific bit flags of the operation
addrAddress of the incoming data, may be NULL
adrlenLength of the valid data in address structure

Returns: True if this filter claimed the data

inline Socket*  socket ()

socket

[const]

Get the socket to which the filter is currently attached

Returns: Pointer to the socket of this filter

bool  valid ()

valid

[const]

Check if the socket of this filter is valid

Returns: True if the filter has a valid socket


Generated by: paulc on bussard on Fri Dec 21 16:28:34 2012, using kdoc 2.0a54.