MythTV master
Public Types | Signals | Public Member Functions | Static Public Member Functions | Private Types | Private Slots | Private Member Functions | Private Attributes | List of all members
NetStream Class Reference

Stream content from a URI. More...

#include <libmythtv/mheg/netstream.h>

Inheritance diagram for NetStream:
[legend]
Collaboration diagram for NetStream:
[legend]

Public Types

enum  EMode : std::uint8_t { kNeverCache , kPreferCache , kAlwaysCache }
 

Signals

void ReadyRead (QObject *)
 
void Finished (QObject *)
 

Public Member Functions

 NetStream (const QUrl &url, EMode mode=kPreferCache, QByteArray cert=QByteArray())
 Network streaming request. More...
 
 ~NetStream () override
 
bool IsOpen () const
 
void Abort ()
 
int safe_read (void *data, unsigned sz, unsigned millisecs=0)
 
qlonglong Seek (qlonglong pos)
 
qlonglong GetReadPosition () const
 
qlonglong GetSize () const
 
const QUrl & Url () const
 
bool WaitTillReady (std::chrono::milliseconds timeout)
 Synchronous interface. More...
 
bool WaitTillFinished (std::chrono::milliseconds timeout)
 
QNetworkReply::NetworkError GetError () const
 
QString GetErrorString () const
 
qlonglong BytesAvailable () const
 
QByteArray ReadAll ()
 
bool isStarted () const
 Asynchronous interface. More...
 
bool isReady () const
 
bool isFinished () const
 

Static Public Member Functions

static bool IsSupported (const QUrl &url)
 RingBuffer interface. More...
 
static QDateTime GetLastModified (const QUrl &url)
 
static bool isAvailable ()
 Public helpers. More...
 

Private Types

enum  : std::uint8_t {
  kClosed , kPending , kStarted , kReady ,
  kFinished
}
 

Private Slots

void slotRequestStarted (int id, QNetworkReply *reply)
 
void slotFinished ()
 
void slotSslErrors (const QList< QSslError > &errors)
 
void slotReadyRead ()
 

Private Member Functions

bool Request (const QUrl &url)
 

Private Attributes

const int m_id
 
const QUrl m_url
 
QMutex m_mutex
 
QNetworkRequest m_request
 
enum NetStream:: { ... }  kClosed
 
NetStreamRequest * m_pending {nullptr}
 
QNetworkReply * m_reply {nullptr}
 
int m_nRedirections {0}
 
qlonglong m_size {-1}
 
qlonglong m_pos {0}
 
QByteArray m_cert
 
QWaitCondition m_ready
 
QWaitCondition m_finished
 

Detailed Description

Stream content from a URI.

Definition at line 31 of file netstream.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : std::uint8_t
private
Enumerator
kClosed 
kPending 
kStarted 
kReady 
kFinished 

Definition at line 99 of file netstream.h.

◆ EMode

enum NetStream::EMode : std::uint8_t
Enumerator
kNeverCache 
kPreferCache 
kAlwaysCache 

Definition at line 36 of file netstream.h.

Constructor & Destructor Documentation

◆ NetStream()

NetStream::NetStream ( const QUrl &  url,
EMode  mode = kPreferCache,
QByteArray  cert = QByteArray() 
)
explicit

Network streaming request.

Definition at line 96 of file netstream.cpp.

◆ ~NetStream()

NetStream::~NetStream ( )
override

Definition at line 124 of file netstream.cpp.

Member Function Documentation

◆ Abort()

void NetStream::Abort ( )

Definition at line 543 of file netstream.cpp.

Referenced by ~NetStream().

◆ BytesAvailable()

qlonglong NetStream::BytesAvailable ( ) const

Definition at line 685 of file netstream.cpp.

◆ Finished

void NetStream::Finished ( QObject *  )
signal

Referenced by MHInteractionChannel::CheckFile(), MHInteractionChannel::GetFile(), and slotFinished().

◆ GetError()

QNetworkReply::NetworkError NetStream::GetError ( void  ) const

Definition at line 673 of file netstream.cpp.

Referenced by MHInteractionChannel::GetFile().

◆ GetErrorString()

QString NetStream::GetErrorString ( ) const

Definition at line 679 of file netstream.cpp.

◆ GetLastModified()

QDateTime NetStream::GetLastModified ( const QUrl &  url)
static

Definition at line 735 of file netstream.cpp.

Referenced by isCached().

◆ GetReadPosition()

qlonglong NetStream::GetReadPosition ( void  ) const

Definition at line 621 of file netstream.cpp.

Referenced by MythInteractiveBuffer::GetReadPosition(), and MythInteractiveBuffer::SeekInternal().

◆ GetSize()

qlonglong NetStream::GetSize ( void  ) const

Definition at line 628 of file netstream.cpp.

Referenced by MythInteractiveBuffer::GetRealFileSizeInternal(), and MythInteractiveBuffer::SeekInternal().

◆ isAvailable()

bool NetStream::isAvailable ( )
static

Public helpers.

Definition at line 728 of file netstream.cpp.

Referenced by MHInteractionChannel::status().

◆ isFinished()

bool NetStream::isFinished ( void  ) const

Definition at line 718 of file netstream.cpp.

◆ IsOpen()

bool NetStream::IsOpen ( void  ) const

Definition at line 537 of file netstream.cpp.

Referenced by MythInteractiveBuffer::IsOpen().

◆ isReady()

bool NetStream::isReady ( ) const

Definition at line 712 of file netstream.cpp.

◆ isStarted()

bool NetStream::isStarted ( ) const

Asynchronous interface.

Definition at line 706 of file netstream.cpp.

◆ IsSupported()

bool NetStream::IsSupported ( const QUrl &  url)
static

RingBuffer interface.

Definition at line 529 of file netstream.cpp.

Referenced by MythInteractiveBuffer::OpenFile(), and Request().

◆ ReadAll()

QByteArray NetStream::ReadAll ( void  )

Definition at line 691 of file netstream.cpp.

Referenced by MHInteractionChannel::GetFile().

◆ ReadyRead

void NetStream::ReadyRead ( QObject *  )
signal

Referenced by slotReadyRead().

◆ Request()

bool NetStream::Request ( const QUrl &  url)
private

Definition at line 159 of file netstream.cpp.

Referenced by NetStream(), Seek(), and slotFinished().

◆ safe_read()

int NetStream::safe_read ( void *  data,
unsigned  sz,
unsigned  millisecs = 0 
)

Definition at line 568 of file netstream.cpp.

Referenced by MythInteractiveBuffer::SafeRead().

◆ Seek()

qlonglong NetStream::Seek ( qlonglong  pos)

Definition at line 600 of file netstream.cpp.

Referenced by MythInteractiveBuffer::SeekInternal().

◆ slotFinished

void NetStream::slotFinished ( )
privateslot

Definition at line 418 of file netstream.cpp.

Referenced by slotRequestStarted().

◆ slotReadyRead

void NetStream::slotReadyRead ( )
privateslot

Definition at line 367 of file netstream.cpp.

Referenced by slotRequestStarted().

◆ slotRequestStarted

void NetStream::slotRequestStarted ( int  id,
QNetworkReply *  reply 
)
privateslot

Definition at line 279 of file netstream.cpp.

Referenced by NetStream().

◆ slotSslErrors

void NetStream::slotSslErrors ( const QList< QSslError > &  errors)
privateslot

Definition at line 487 of file netstream.cpp.

Referenced by slotRequestStarted().

◆ Url()

const QUrl & NetStream::Url ( void  ) const
inline

Definition at line 52 of file netstream.h.

◆ WaitTillFinished()

bool NetStream::WaitTillFinished ( std::chrono::milliseconds  timeout)

Definition at line 656 of file netstream.cpp.

Referenced by MHInteractionChannel::GetFile().

◆ WaitTillReady()

bool NetStream::WaitTillReady ( std::chrono::milliseconds  timeout)

Synchronous interface.

Definition at line 639 of file netstream.cpp.

Member Data Documentation

◆ 

enum { ... } NetStream::kClosed

Referenced by IsOpen().

◆ m_cert

QByteArray NetStream::m_cert
private

Definition at line 106 of file netstream.h.

Referenced by Request().

◆ m_finished

QWaitCondition NetStream::m_finished
private

Definition at line 108 of file netstream.h.

Referenced by slotFinished(), and WaitTillFinished().

◆ m_id

const int NetStream::m_id
private

Definition at line 94 of file netstream.h.

Referenced by Abort(), Request(), safe_read(), Seek(), slotFinished(), slotReadyRead(), slotRequestStarted(), and slotSslErrors().

◆ m_mutex

QMutex NetStream::m_mutex
mutableprivate

Definition at line 97 of file netstream.h.

Referenced by Abort(), BytesAvailable(), GetError(), GetErrorString(), GetReadPosition(), GetSize(), isFinished(), IsOpen(), isReady(), isStarted(), NetStream(), ReadAll(), safe_read(), Seek(), slotFinished(), slotReadyRead(), slotRequestStarted(), slotSslErrors(), WaitTillFinished(), WaitTillReady(), and ~NetStream().

◆ m_nRedirections

int NetStream::m_nRedirections {0}
private

Definition at line 103 of file netstream.h.

Referenced by slotFinished().

◆ m_pending

NetStreamRequest* NetStream::m_pending {nullptr}
private

Definition at line 101 of file netstream.h.

Referenced by Abort(), Request(), and slotRequestStarted().

◆ m_pos

qlonglong NetStream::m_pos {0}
private

Definition at line 105 of file netstream.h.

Referenced by GetReadPosition(), ReadAll(), Request(), safe_read(), Seek(), and slotFinished().

◆ m_ready

QWaitCondition NetStream::m_ready
private

Definition at line 107 of file netstream.h.

Referenced by safe_read(), slotReadyRead(), and WaitTillReady().

◆ m_reply

QNetworkReply* NetStream::m_reply {nullptr}
private

Definition at line 102 of file netstream.h.

Referenced by Abort(), BytesAvailable(), GetError(), GetErrorString(), ReadAll(), Request(), safe_read(), slotFinished(), slotReadyRead(), slotRequestStarted(), slotSslErrors(), and ~NetStream().

◆ m_request

QNetworkRequest NetStream::m_request
private

Definition at line 98 of file netstream.h.

Referenced by NetStream(), Request(), Seek(), and slotFinished().

◆ m_size

qlonglong NetStream::m_size {-1}
private

Definition at line 104 of file netstream.h.

Referenced by GetSize(), Request(), safe_read(), Seek(), slotFinished(), and slotReadyRead().

◆ m_url

const QUrl NetStream::m_url
private

Definition at line 95 of file netstream.h.

Referenced by Url().

The documentation for this class was generated from the following files:
Generated on Sat Nov 29 2025 03:16:56 for MythTV by doxygen 1.9.4