webkit  2cdf99a9e3038c7e01b3c37e8ad903ecbe5eecf1
https://github.com/WebKit/webkit
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
rtc::StreamInterface Class Referenceabstract

#include <stream.h>

Inheritance diagram for rtc::StreamInterface:
rtc::MessageHandler rtc::MessageHandler BufferQueueStream cricket::StreamInterfaceChannel cricket::StreamInterfaceChannel rtc::FifoBuffer rtc::FifoBuffer rtc::FileRotatingStream rtc::FileRotatingStream rtc::FileStream rtc::FileStream rtc::MemoryStreamBase rtc::MemoryStreamBase rtc::NullStream rtc::NullStream rtc::SocketStream rtc::SocketStream rtc::StreamAdapterInterface rtc::StreamAdapterInterface rtc::StringStream rtc::StringStream rtc::TestStream SSLDummyStreamBase testing::StreamSource testing::StreamSource

Public Types

enum  { MSG_POST_EVENT = 0xF1F1, MSG_MAX = MSG_POST_EVENT }
 
enum  { MSG_POST_EVENT = 0xF1F1, MSG_MAX = MSG_POST_EVENT }
 

Public Member Functions

 ~StreamInterface () override
 
virtual StreamState GetState () const =0
 
virtual StreamResult Read (void *buffer, size_t buffer_len, size_t *read, int *error)=0
 
virtual StreamResult Write (const void *data, size_t data_len, size_t *written, int *error)=0
 
virtual void Close ()=0
 
void PostEvent (Thread *t, int events, int err)
 
void PostEvent (int events, int err)
 
virtual const void * GetReadData (size_t *data_len)
 
virtual void ConsumeReadData (size_t)
 
virtual void * GetWriteBuffer (size_t *buf_len)
 
virtual void ConsumeWriteBuffer (size_t)
 
virtual bool SetPosition (size_t position)
 
virtual bool GetPosition (size_t *position) const
 
virtual bool GetSize (size_t *size) const
 
virtual bool GetAvailable (size_t *size) const
 
virtual bool GetWriteRemaining (size_t *size) const
 
virtual bool Flush ()
 
virtual bool ReserveSize (size_t size)
 
bool Rewind ()
 
StreamResult WriteAll (const void *data, size_t data_len, size_t *written, int *error)
 
StreamResult ReadAll (void *buffer, size_t buffer_len, size_t *read, int *error)
 
StreamResult ReadLine (std::string *line)
 
 ~StreamInterface () override
 
virtual StreamState GetState () const =0
 
virtual StreamResult Read (void *buffer, size_t buffer_len, size_t *read, int *error)=0
 
virtual StreamResult Write (const void *data, size_t data_len, size_t *written, int *error)=0
 
virtual void Close ()=0
 
void PostEvent (Thread *t, int events, int err)
 
void PostEvent (int events, int err)
 
virtual const void * GetReadData (size_t *data_len)
 
virtual void ConsumeReadData (size_t)
 
virtual void * GetWriteBuffer (size_t *buf_len)
 
virtual void ConsumeWriteBuffer (size_t)
 
virtual bool SetPosition (size_t position)
 
virtual bool GetPosition (size_t *position) const
 
virtual bool GetSize (size_t *size) const
 
virtual bool GetAvailable (size_t *size) const
 
virtual bool GetWriteRemaining (size_t *size) const
 
virtual bool Flush ()
 
virtual bool ReserveSize (size_t size)
 
bool Rewind ()
 
StreamResult WriteAll (const void *data, size_t data_len, size_t *written, int *error)
 
StreamResult ReadAll (void *buffer, size_t buffer_len, size_t *read, int *error)
 
StreamResult ReadLine (std::string *line)
 
- Public Member Functions inherited from rtc::MessageHandler
virtual WEBRTC_DYLIB_EXPORT ~MessageHandler ()
 
virtual WEBRTC_DYLIB_EXPORT ~MessageHandler ()
 

Public Attributes

sigslot::signal3< StreamInterface *, int, int > SignalEvent
 

Protected Member Functions

 StreamInterface ()
 
void OnMessage (Message *msg) override
 
 StreamInterface ()
 
void OnMessage (Message *msg) override
 
- Protected Member Functions inherited from rtc::MessageHandler
 MessageHandler ()
 
 MessageHandler ()
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
MSG_POST_EVENT 
MSG_MAX 

◆ anonymous enum

anonymous enum
Enumerator
MSG_POST_EVENT 
MSG_MAX 

Constructor & Destructor Documentation

◆ ~StreamInterface() [1/2]

rtc::StreamInterface::~StreamInterface ( )
override

◆ StreamInterface() [1/2]

rtc::StreamInterface::StreamInterface ( )
protected

◆ ~StreamInterface() [2/2]

rtc::StreamInterface::~StreamInterface ( )
override

◆ StreamInterface() [2/2]

rtc::StreamInterface::StreamInterface ( )
protected

Member Function Documentation

◆ Close() [1/2]

virtual void rtc::StreamInterface::Close ( )
pure virtual

Implemented in rtc::StringStream, rtc::StringStream, rtc::LoggingAdapter, rtc::LoggingAdapter, rtc::FifoBuffer, rtc::FifoBuffer, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::NullStream, rtc::NullStream, testing::StreamSource, testing::StreamSource, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, BufferQueueStream, SSLDummyStreamBase, rtc::OpenSSLStreamAdapter, rtc::OpenSSLStreamAdapter, rtc::TransformAdapter, rtc::TransformAdapter, rtc::FileRotatingStream, rtc::FileRotatingStream, rtc::SocketStream, rtc::SocketStream, cricket::StreamInterfaceChannel, rtc::TestStream, and cricket::StreamInterfaceChannel.

◆ Close() [2/2]

virtual void rtc::StreamInterface::Close ( )
pure virtual

Implemented in rtc::StringStream, rtc::StringStream, rtc::LoggingAdapter, rtc::LoggingAdapter, rtc::FifoBuffer, rtc::FifoBuffer, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::NullStream, rtc::NullStream, testing::StreamSource, testing::StreamSource, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, BufferQueueStream, SSLDummyStreamBase, rtc::OpenSSLStreamAdapter, rtc::OpenSSLStreamAdapter, rtc::TransformAdapter, rtc::TransformAdapter, rtc::FileRotatingStream, rtc::FileRotatingStream, rtc::SocketStream, rtc::SocketStream, cricket::StreamInterfaceChannel, rtc::TestStream, and cricket::StreamInterfaceChannel.

◆ ConsumeReadData() [1/2]

virtual void rtc::StreamInterface::ConsumeReadData ( size_t  )
inlinevirtual

Reimplemented in rtc::FifoBuffer, and rtc::FifoBuffer.

◆ ConsumeReadData() [2/2]

virtual void rtc::StreamInterface::ConsumeReadData ( size_t  )
inlinevirtual

Reimplemented in rtc::FifoBuffer, and rtc::FifoBuffer.

◆ ConsumeWriteBuffer() [1/2]

virtual void rtc::StreamInterface::ConsumeWriteBuffer ( size_t  )
inlinevirtual

Reimplemented in rtc::FifoBuffer, and rtc::FifoBuffer.

◆ ConsumeWriteBuffer() [2/2]

virtual void rtc::StreamInterface::ConsumeWriteBuffer ( size_t  )
inlinevirtual

Reimplemented in rtc::FifoBuffer, and rtc::FifoBuffer.

◆ Flush() [1/2]

bool rtc::StreamInterface::Flush ( )
virtual

Reimplemented in rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, rtc::FileRotatingStream, and rtc::FileRotatingStream.

◆ Flush() [2/2]

virtual bool rtc::StreamInterface::Flush ( )
virtual

Reimplemented in rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, rtc::FileRotatingStream, and rtc::FileRotatingStream.

◆ GetAvailable() [1/2]

virtual bool rtc::StreamInterface::GetAvailable ( size_t *  size) const
virtual

Reimplemented in rtc::StringStream, rtc::StringStream, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, rtc::TransformAdapter, rtc::TransformAdapter, and rtc::TestStream.

◆ GetAvailable() [2/2]

bool rtc::StreamInterface::GetAvailable ( size_t *  size) const
virtual

Reimplemented in rtc::StringStream, rtc::StringStream, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, rtc::TransformAdapter, rtc::TransformAdapter, and rtc::TestStream.

◆ GetPosition() [1/2]

virtual bool rtc::StreamInterface::GetPosition ( size_t *  position) const
virtual

Reimplemented in rtc::StringStream, rtc::StringStream, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, and rtc::TestStream.

◆ GetPosition() [2/2]

bool rtc::StreamInterface::GetPosition ( size_t *  position) const
virtual

Reimplemented in rtc::StringStream, rtc::StringStream, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, and rtc::TestStream.

◆ GetReadData() [1/2]

const void * rtc::StreamInterface::GetReadData ( size_t *  data_len)
virtual

Reimplemented in rtc::FifoBuffer, and rtc::FifoBuffer.

◆ GetReadData() [2/2]

virtual const void* rtc::StreamInterface::GetReadData ( size_t *  data_len)
virtual

Reimplemented in rtc::FifoBuffer, and rtc::FifoBuffer.

◆ GetSize() [1/2]

virtual bool rtc::StreamInterface::GetSize ( size_t *  size) const
virtual

Reimplemented in rtc::StringStream, rtc::StringStream, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, rtc::FileRotatingStream, rtc::FileRotatingStream, and rtc::TestStream.

◆ GetSize() [2/2]

bool rtc::StreamInterface::GetSize ( size_t *  size) const
virtual

Reimplemented in rtc::StringStream, rtc::StringStream, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, rtc::FileRotatingStream, rtc::FileRotatingStream, and rtc::TestStream.

◆ GetState() [1/2]

virtual StreamState rtc::StreamInterface::GetState ( ) const
pure virtual

Implemented in rtc::StringStream, rtc::StringStream, rtc::FifoBuffer, rtc::FifoBuffer, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::NullStream, rtc::NullStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, testing::StreamSource, testing::StreamSource, BufferQueueStream, rtc::OpenSSLStreamAdapter, rtc::OpenSSLStreamAdapter, SSLDummyStreamBase, rtc::FileRotatingStream, rtc::FileRotatingStream, cricket::StreamInterfaceChannel, cricket::StreamInterfaceChannel, rtc::SocketStream, rtc::SocketStream, and rtc::TestStream.

◆ GetState() [2/2]

virtual StreamState rtc::StreamInterface::GetState ( ) const
pure virtual

Implemented in rtc::StringStream, rtc::StringStream, rtc::FifoBuffer, rtc::FifoBuffer, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::NullStream, rtc::NullStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, testing::StreamSource, testing::StreamSource, BufferQueueStream, rtc::OpenSSLStreamAdapter, rtc::OpenSSLStreamAdapter, SSLDummyStreamBase, rtc::FileRotatingStream, rtc::FileRotatingStream, cricket::StreamInterfaceChannel, cricket::StreamInterfaceChannel, rtc::SocketStream, rtc::SocketStream, and rtc::TestStream.

◆ GetWriteBuffer() [1/2]

void * rtc::StreamInterface::GetWriteBuffer ( size_t *  buf_len)
virtual

Reimplemented in rtc::FifoBuffer, and rtc::FifoBuffer.

◆ GetWriteBuffer() [2/2]

virtual void* rtc::StreamInterface::GetWriteBuffer ( size_t *  buf_len)
virtual

Reimplemented in rtc::FifoBuffer, and rtc::FifoBuffer.

◆ GetWriteRemaining() [1/2]

virtual bool rtc::StreamInterface::GetWriteRemaining ( size_t *  size) const
virtual

Reimplemented in rtc::FifoBuffer, rtc::FifoBuffer, rtc::StreamAdapterInterface, and rtc::StreamAdapterInterface.

◆ GetWriteRemaining() [2/2]

bool rtc::StreamInterface::GetWriteRemaining ( size_t *  size) const
virtual

Reimplemented in rtc::FifoBuffer, rtc::FifoBuffer, rtc::StreamAdapterInterface, and rtc::StreamAdapterInterface.

◆ OnMessage() [1/2]

void rtc::StreamInterface::OnMessage ( Message *  msg)
overrideprotectedvirtual

Implements rtc::MessageHandler.

◆ OnMessage() [2/2]

void rtc::StreamInterface::OnMessage ( Message *  msg)
overrideprotectedvirtual

Implements rtc::MessageHandler.

◆ PostEvent() [1/4]

void rtc::StreamInterface::PostEvent ( Thread *  t,
int  events,
int  err 
)

◆ PostEvent() [2/4]

void rtc::StreamInterface::PostEvent ( Thread *  t,
int  events,
int  err 
)

◆ PostEvent() [3/4]

void rtc::StreamInterface::PostEvent ( int  events,
int  err 
)

◆ PostEvent() [4/4]

void rtc::StreamInterface::PostEvent ( int  events,
int  err 
)

◆ Read() [1/2]

virtual StreamResult rtc::StreamInterface::Read ( void *  buffer,
size_t  buffer_len,
size_t *  read,
int *  error 
)
pure virtual

Implemented in rtc::StringStream, rtc::StringStream, rtc::LoggingAdapter, rtc::LoggingAdapter, rtc::FifoBuffer, rtc::FifoBuffer, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::NullStream, rtc::NullStream, rtc::StreamTap, rtc::StreamTap, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, testing::StreamSource, testing::StreamSource, BufferQueueStream, SSLDummyStreamBase, rtc::OpenSSLStreamAdapter, rtc::OpenSSLStreamAdapter, rtc::TransformAdapter, rtc::TransformAdapter, rtc::FileRotatingStream, rtc::FileRotatingStream, cricket::StreamInterfaceChannel, cricket::StreamInterfaceChannel, rtc::SocketStream, rtc::SocketStream, and rtc::TestStream.

◆ Read() [2/2]

virtual StreamResult rtc::StreamInterface::Read ( void *  buffer,
size_t  buffer_len,
size_t *  read,
int *  error 
)
pure virtual

Implemented in rtc::StringStream, rtc::StringStream, rtc::LoggingAdapter, rtc::LoggingAdapter, rtc::FifoBuffer, rtc::FifoBuffer, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::NullStream, rtc::NullStream, rtc::StreamTap, rtc::StreamTap, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, testing::StreamSource, testing::StreamSource, BufferQueueStream, SSLDummyStreamBase, rtc::OpenSSLStreamAdapter, rtc::OpenSSLStreamAdapter, rtc::TransformAdapter, rtc::TransformAdapter, rtc::FileRotatingStream, rtc::FileRotatingStream, cricket::StreamInterfaceChannel, cricket::StreamInterfaceChannel, rtc::SocketStream, rtc::SocketStream, and rtc::TestStream.

◆ ReadAll() [1/2]

StreamResult rtc::StreamInterface::ReadAll ( void *  buffer,
size_t  buffer_len,
size_t *  read,
int *  error 
)

◆ ReadAll() [2/2]

StreamResult rtc::StreamInterface::ReadAll ( void *  buffer,
size_t  buffer_len,
size_t *  read,
int *  error 
)

◆ ReadLine() [1/2]

StreamResult rtc::StreamInterface::ReadLine ( std::string *  line)

◆ ReadLine() [2/2]

StreamResult rtc::StreamInterface::ReadLine ( std::string *  line)

◆ ReserveSize() [1/2]

bool rtc::StreamInterface::ReserveSize ( size_t  size)
virtual

Reimplemented in rtc::StringStream, rtc::StringStream, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, rtc::TransformAdapter, and rtc::TransformAdapter.

◆ ReserveSize() [2/2]

virtual bool rtc::StreamInterface::ReserveSize ( size_t  size)
virtual

Reimplemented in rtc::StringStream, rtc::StringStream, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, rtc::TransformAdapter, and rtc::TransformAdapter.

◆ Rewind() [1/2]

bool rtc::StreamInterface::Rewind ( )
inline

◆ Rewind() [2/2]

bool rtc::StreamInterface::Rewind ( )
inline

◆ SetPosition() [1/2]

bool rtc::StreamInterface::SetPosition ( size_t  position)
virtual

Reimplemented in rtc::StringStream, rtc::StringStream, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, and rtc::TestStream.

◆ SetPosition() [2/2]

virtual bool rtc::StreamInterface::SetPosition ( size_t  position)
virtual

Reimplemented in rtc::StringStream, rtc::StringStream, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, and rtc::TestStream.

◆ Write() [1/2]

virtual StreamResult rtc::StreamInterface::Write ( const void *  data,
size_t  data_len,
size_t *  written,
int *  error 
)
pure virtual

Implemented in rtc::StringStream, rtc::StringStream, rtc::LoggingAdapter, rtc::LoggingAdapter, rtc::FifoBuffer, rtc::FifoBuffer, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::NullStream, rtc::NullStream, rtc::StreamTap, rtc::StreamTap, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, testing::StreamSource, testing::StreamSource, BufferQueueStream, SSLDummyStreamBase, rtc::OpenSSLStreamAdapter, rtc::OpenSSLStreamAdapter, rtc::TransformAdapter, rtc::TransformAdapter, rtc::FileRotatingStream, rtc::FileRotatingStream, cricket::StreamInterfaceChannel, cricket::StreamInterfaceChannel, rtc::SocketStream, rtc::SocketStream, and rtc::TestStream.

◆ Write() [2/2]

virtual StreamResult rtc::StreamInterface::Write ( const void *  data,
size_t  data_len,
size_t *  written,
int *  error 
)
pure virtual

Implemented in rtc::StringStream, rtc::StringStream, rtc::LoggingAdapter, rtc::LoggingAdapter, rtc::FifoBuffer, rtc::FifoBuffer, rtc::MemoryStreamBase, rtc::MemoryStreamBase, rtc::FileStream, rtc::FileStream, rtc::NullStream, rtc::NullStream, rtc::StreamTap, rtc::StreamTap, rtc::StreamAdapterInterface, rtc::StreamAdapterInterface, testing::StreamSource, testing::StreamSource, BufferQueueStream, SSLDummyStreamBase, rtc::OpenSSLStreamAdapter, rtc::OpenSSLStreamAdapter, rtc::TransformAdapter, rtc::TransformAdapter, rtc::FileRotatingStream, rtc::FileRotatingStream, cricket::StreamInterfaceChannel, cricket::StreamInterfaceChannel, rtc::SocketStream, rtc::SocketStream, and rtc::TestStream.

◆ WriteAll() [1/2]

StreamResult rtc::StreamInterface::WriteAll ( const void *  data,
size_t  data_len,
size_t *  written,
int *  error 
)

◆ WriteAll() [2/2]

StreamResult rtc::StreamInterface::WriteAll ( const void *  data,
size_t  data_len,
size_t *  written,
int *  error 
)

Member Data Documentation

◆ SignalEvent

sigslot::signal3< StreamInterface *, int, int > rtc::StreamInterface::SignalEvent
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13