VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Friends
makVrv::DtTcpTaskElement Class Reference

A DtTcpTaskElement instance will create a pipeline element that can output the image being streamed to a tcp port. More...

Inheritance diagram for makVrv::DtTcpTaskElement:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtTcpTaskElement ()
 DTOR.
virtual void setPort (int port)
 Set the port the element will send the image to.
virtual int port () const
 Get the port the element has been configured to use.
virtual void setFromRecord (const makArchives::DtImageTaskRecord &config)
 Initialize the tcp task from a DtImageTaskRecord.
virtual bool configure ()
 Configure the tcp task.
- Public Member Functions inherited from makVrv::DtImageTaskElement
virtual ~DtImageTaskElement ()
 DTOR.
void preFrame ()
 Thread of execution before each frame's processing.
void processFrame (DtVideoFrameBuffer *frame)
 Process the image.
void postFrame ()
 Thread of execution after each frame's processing.
virtual void attach (DtImageTaskElement *next)
 Place another Image Task element after this one.

Protected Member Functions

 DtTcpTaskElement (DtDe &de, DtProcessImageTask *owningTask)
 CTOR (protected)
void handlePreFrame ()
 Check any connection before processing the image.
void handleProcessFrame (DtVideoFrameBuffer *frame)
 Copy the current frame to the tcp port.
bool handleSocketAddition (DtInetSocket *socket)
 Handle a new client.
bool handleSocketRemoval (DtInetSocket *socket)
 Handle a disconnect.
- Protected Member Functions inherited from makVrv::DtImageTaskElement
 DtImageTaskElement (DtDe &de, DtProcessImageTask *owningTask)
 CTOR.
virtual void handlePostFrame ()
 No-op in base class.

Static Protected Member Functions

static bool socketAdditionCallback (DtInetSocket *sock, void *usr)
 VR-Link callback when a connection is initiated.
static bool socketRemovalCallback (DtInetSocket *sock, void *usr)
 VR-Link callback when a connection is terminated Calls handleSocketRemoval().

Protected Attributes

int myPort
DtInetSocketMgr * mySocketManager
DtInetTcpSocket * myConnectedSocket
- Protected Attributes inherited from makVrv::DtImageTaskElement
DtDemyDe
DtProcessImageTaskmyOwningTask
DtImageTaskElementmyNextElement

Private Member Functions

 DtTcpTaskElement ()
 Default CTOR (unimplemented)
 DtTcpTaskElement (const DtTcpTaskElement &orig)
 Copy CTOR (unimplemented)
DtTcpTaskElementoperator= (const DtTcpTaskElement &rhs)
 Assignment operator (unimplemented)

Friends

class DtTcpTaskElementCreator
 Friend creator class, the only class that can construct an instance of this DtTcpTaskElement.

Detailed Description

A DtTcpTaskElement instance will create a pipeline element that can output the image being streamed to a tcp port.

Constructor & Destructor Documentation

virtual makVrv::DtTcpTaskElement::~DtTcpTaskElement ( )
virtual

DTOR.

makVrv::DtTcpTaskElement::DtTcpTaskElement ( DtDe de,
DtProcessImageTask owningTask 
)
protected

CTOR (protected)

makVrv::DtTcpTaskElement::DtTcpTaskElement ( )
private

Default CTOR (unimplemented)

makVrv::DtTcpTaskElement::DtTcpTaskElement ( const DtTcpTaskElement orig)
private

Copy CTOR (unimplemented)

Member Function Documentation

virtual void makVrv::DtTcpTaskElement::setPort ( int  port)
virtual

Set the port the element will send the image to.

virtual int makVrv::DtTcpTaskElement::port ( ) const
virtual

Get the port the element has been configured to use.

virtual void makVrv::DtTcpTaskElement::setFromRecord ( const makArchives::DtImageTaskRecord config)
virtual

Initialize the tcp task from a DtImageTaskRecord.

Reimplemented from makVrv::DtImageTaskElement.

virtual bool makVrv::DtTcpTaskElement::configure ( )
virtual

Configure the tcp task.

Reimplemented from makVrv::DtImageTaskElement.

void makVrv::DtTcpTaskElement::handlePreFrame ( )
protectedvirtual

Check any connection before processing the image.

Reimplemented from makVrv::DtImageTaskElement.

void makVrv::DtTcpTaskElement::handleProcessFrame ( DtVideoFrameBuffer frame)
protectedvirtual

Copy the current frame to the tcp port.

Implements makVrv::DtImageTaskElement.

bool makVrv::DtTcpTaskElement::handleSocketAddition ( DtInetSocket *  socket)
protected

Handle a new client.

bool makVrv::DtTcpTaskElement::handleSocketRemoval ( DtInetSocket *  socket)
protected

Handle a disconnect.

static bool makVrv::DtTcpTaskElement::socketAdditionCallback ( DtInetSocket *  sock,
void *  usr 
)
staticprotected

VR-Link callback when a connection is initiated.

Calls handleSocketAddition().

static bool makVrv::DtTcpTaskElement::socketRemovalCallback ( DtInetSocket *  sock,
void *  usr 
)
staticprotected

VR-Link callback when a connection is terminated Calls handleSocketRemoval().

DtTcpTaskElement& makVrv::DtTcpTaskElement::operator= ( const DtTcpTaskElement rhs)
private

Assignment operator (unimplemented)

Friends And Related Function Documentation

friend class DtTcpTaskElementCreator
friend

Friend creator class, the only class that can construct an instance of this DtTcpTaskElement.

Member Data Documentation

int makVrv::DtTcpTaskElement::myPort
protected
DtInetSocketMgr* makVrv::DtTcpTaskElement::mySocketManager
protected
DtInetTcpSocket* makVrv::DtTcpTaskElement::myConnectedSocket
protected

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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)