VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
makVrv::DtWebSocketTaskElement Class Reference

A DtWebSocketTaskElement instance will create a pipeline element that can listen for an web connection and stream video to the client. Note: LWS is not thread safe.

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

Public Member Functions

virtual ~DtWebSocketTaskElement ()
 
virtual void setFromRecord (const makArchives::DtImageTaskRecord &config)
 
virtual bool configure ()
 
DtLocklessQueue< std::string > & queue ()
 
virtual const int port () const
 
virtual const std::string & htmlFileNameToServe () const
 
virtual void setTxPacketSize (unsigned int size)
 
virtual unsigned int txPacketSize ()
 
- Public Member Functions inherited from makVrv::DtImageTaskElement
virtual ~DtImageTaskElement ()
 
void preFrame ()
 
void processFrame (DtVideoFrameBuffer *frame)
 
void postFrame ()
 
virtual void attach (DtImageTaskElement *next)
 

Protected Member Functions

 DtWebSocketTaskElement (DtDe &de, DtProcessImageTask *owningTask)
 
void handlePreFrame ()
 
void handleProcessFrame (DtVideoFrameBuffer *frame)
 
bool generateAndWriteHtml ()
 
void buildProtocols ()
 
- Protected Member Functions inherited from makVrv::DtImageTaskElement
 DtImageTaskElement (DtDe &de, DtProcessImageTask *owningTask)
 
virtual void handlePostFrame ()
 

Protected Attributes

lws_context * myContext
 
lws_vhost * myVHost
 
struct lws_protocols myProtocols [3]
 
DtLocklessQueue< std::string > * myCommandQueue
 
int myPort
 
unsigned int myTxPacketSize
 
std::string myHTMLFileNameToServe
 
- Protected Attributes inherited from makVrv::DtImageTaskElement
DtDemyDe
 
DtProcessImageTaskmyOwningTask
 
DtImageTaskElementmyNextElement
 

Friends

class DtWebSocketTaskElementCreator
 

Constructor & Destructor Documentation

virtual makVrv::DtWebSocketTaskElement::~DtWebSocketTaskElement ( )
virtual
makVrv::DtWebSocketTaskElement::DtWebSocketTaskElement ( DtDe de,
DtProcessImageTask owningTask 
)
protected

CTOR (protected)

Member Function Documentation

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

Initialize the websocket image task element from a task record.

Reimplemented from makVrv::DtImageTaskElement.

virtual bool makVrv::DtWebSocketTaskElement::configure ( )
virtual

Configure the websocket image task element.

Reimplemented from makVrv::DtImageTaskElement.

DtLocklessQueue<std::string>& makVrv::DtWebSocketTaskElement::queue ( )
inline
virtual const int makVrv::DtWebSocketTaskElement::port ( ) const
virtual

Get the port.

virtual const std::string& makVrv::DtWebSocketTaskElement::htmlFileNameToServe ( ) const
virtual

Name of the html file stored in bin64/html Format : videoOnPort myPort .html.

virtual void makVrv::DtWebSocketTaskElement::setTxPacketSize ( unsigned int  size)
virtual

The tx_packet_size for the image stream callback Set higher if the pipe is choking Default 600000.

virtual unsigned int makVrv::DtWebSocketTaskElement::txPacketSize ( )
virtual
void makVrv::DtWebSocketTaskElement::handlePreFrame ( )
protectedvirtual

Call lws_service.

Reimplemented from makVrv::DtImageTaskElement.

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

Pass a frame to the callbakcs.

Implements makVrv::DtImageTaskElement.

bool makVrv::DtWebSocketTaskElement::generateAndWriteHtml ( )
protected

Generate html files under bin64/html.

void makVrv::DtWebSocketTaskElement::buildProtocols ( )
protected

Populate myProtocols.

Friends And Related Function Documentation

friend class DtWebSocketTaskElementCreator
friend

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

Member Data Documentation

lws_context* makVrv::DtWebSocketTaskElement::myContext
protected
lws_vhost* makVrv::DtWebSocketTaskElement::myVHost
protected
struct lws_protocols makVrv::DtWebSocketTaskElement::myProtocols[3]
protected
DtLocklessQueue<std::string>* makVrv::DtWebSocketTaskElement::myCommandQueue
protected
int makVrv::DtWebSocketTaskElement::myPort
protected
unsigned int makVrv::DtWebSocketTaskElement::myTxPacketSize
protected
std::string makVrv::DtWebSocketTaskElement::myHTMLFileNameToServe
protected

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

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)