KVIrc 5.2.6
Developer APIs
KviHttpRequest Class Reference

#include <KviHttpRequest.h>

+ Inheritance diagram for KviHttpRequest:

Public Types

enum  ExistingFileAction { Overwrite , RenameIncoming , RenameExisting , Resume }
 
enum  ProcessingType {
  HeadersOnly , WholeFile , Blocks , Lines ,
  StoreToFile
}
 

Signals

void binaryData (const KviDataBuffer &data)
 
void connectionEstablished ()
 
void contactingHost (const QString &ipandport)
 
void data (const KviCString &data)
 
void header (KviPointerHashTable< const char *, KviCString > *hdr)
 
void receivedResponse (const QString &response)
 
void requestSent (const QStringList &request)
 
void resolvingHost (const QString &hostname)
 
void status (const QString &message)
 
void terminated (bool bSuccess)
 

Public Member Functions

void abort ()
 
unsigned int contentOffset ()
 
ExistingFileAction existingFileAction ()
 
const QString & fileName ()
 
bool followRedirects () const
 
bool get (const KviUrl &u, ProcessingType p=WholeFile, const QString &szFileName=QString())
 
 KviHttpRequest ()
 
const QString & lastError ()
 
unsigned int maxContentLength ()
 
void * privateData ()
 
ProcessingType processingType ()
 
unsigned int receivedSize ()
 
void reset ()
 
void setConnectionTimeout (unsigned int uConnectionTimeout)
 
void setContentOffset (int uContentOffset)
 
void setExistingFileAction (ExistingFileAction a)
 
void setFileName (const QString &szFileName)
 
void setFollowRedirects (bool bFollow)
 
void setMaxContentLength (int uMaxContentLength)
 
void setMaximumRedirectCount (unsigned int uCount)
 
void setPostData (const QString &szPostData)
 
void setPrivateData (void *ptr)
 
void setProcessingType (ProcessingType t)
 
void setUrl (const KviUrl &u)
 
bool start ()
 
unsigned int totalSize ()
 
const KviUrlurl ()
 
 ~KviHttpRequest ()
 

Protected Attributes

bool m_bChunkedTransferEncoding
 
bool m_bFollowRedirects
 
bool m_bGzip
 
bool m_bHeaderProcessed
 
bool m_bIgnoreRemainingData
 
KviUrl m_connectionUrl
 
ExistingFileAction m_eExistingFileAction
 
ProcessingType m_eProcessingType
 
void * m_pPrivateData
 
QString m_szFileName
 
QString m_szLastError
 
QString m_szPostData
 
unsigned int m_uConnectionTimeout
 
unsigned int m_uContentOffset
 
unsigned int m_uMaxContentLength
 
unsigned int m_uMaximumRedirectCount
 
unsigned int m_uReceivedSize
 
unsigned int m_uRedirectCount
 
unsigned int m_uRemainingChunkSize
 
KviUrl m_url
 
unsigned int m_uTotalSize
 

Private Slots

void slotConnectionTimedOut ()
 
void slotSocketConnected ()
 
void slotSocketDisconnected ()
 
void slotSocketError (QAbstractSocket::SocketError socketError)
 
void slotSocketHostResolved ()
 
void slotSocketReadDataReady ()
 

Private Member Functions

void closeSocket ()
 
bool doConnect ()
 
void emitLines (KviDataBuffer *pDataBuffer)
 
bool openFile ()
 
void processData (KviDataBuffer *data)
 
bool processHeader (KviCString &szHeader)
 
void resetData ()
 
void resetInternalStatus ()
 
void resetStatus ()
 

Private Attributes

KviHttpRequestPrivatem_p
 

Member Enumeration Documentation

◆ ExistingFileAction

Enumerator
Overwrite 
RenameIncoming 
RenameExisting 
Resume 

◆ ProcessingType

Enumerator
HeadersOnly 
WholeFile 
Blocks 
Lines 
StoreToFile 

Constructor & Destructor Documentation

◆ KviHttpRequest()

◆ ~KviHttpRequest()

KviHttpRequest::~KviHttpRequest ( )

Member Function Documentation

◆ abort()

void KviHttpRequest::abort ( )

◆ binaryData

void KviHttpRequest::binaryData ( const KviDataBuffer & data)
signal

References data().

Referenced by processData(), and slotSocketDisconnected().

◆ closeSocket()

void KviHttpRequest::closeSocket ( )
private

◆ connectionEstablished

void KviHttpRequest::connectionEstablished ( )
signal

Referenced by slotSocketConnected().

◆ contactingHost

void KviHttpRequest::contactingHost ( const QString & ipandport)
signal

Referenced by slotSocketHostResolved().

◆ contentOffset()

unsigned int KviHttpRequest::contentOffset ( )
inline

References m_uContentOffset.

◆ data

void KviHttpRequest::data ( const KviCString & data)
signal

◆ doConnect()

◆ emitLines()

void KviHttpRequest::emitLines ( KviDataBuffer * pDataBuffer)
private

◆ existingFileAction()

ExistingFileAction KviHttpRequest::existingFileAction ( )
inline

References m_eExistingFileAction.

◆ fileName()

const QString & KviHttpRequest::fileName ( )
inline

References m_szFileName.

◆ followRedirects()

bool KviHttpRequest::followRedirects ( ) const
inline

References m_bFollowRedirects.

◆ get()

bool KviHttpRequest::get ( const KviUrl & u,
ProcessingType p = WholeFile,
const QString & szFileName = QString() )

◆ header

void KviHttpRequest::header ( KviPointerHashTable< const char *, KviCString > * hdr)
signal

Referenced by processHeader().

◆ lastError()

const QString & KviHttpRequest::lastError ( )
inline

References m_szLastError.

Referenced by http_kvs_complete_get().

◆ maxContentLength()

unsigned int KviHttpRequest::maxContentLength ( )
inline

References m_uMaxContentLength.

◆ openFile()

◆ privateData()

void * KviHttpRequest::privateData ( )
inline

References m_pPrivateData.

◆ processData()

◆ processHeader()

◆ processingType()

ProcessingType KviHttpRequest::processingType ( )
inline

References m_eProcessingType.

◆ receivedResponse

void KviHttpRequest::receivedResponse ( const QString & response)
signal

Referenced by processHeader().

◆ receivedSize()

unsigned int KviHttpRequest::receivedSize ( )
inline

References m_uReceivedSize.

◆ requestSent

◆ reset()

void KviHttpRequest::reset ( )

References resetData(), resetInternalStatus(), and resetStatus().

Referenced by get().

◆ resetData()

◆ resetInternalStatus()

◆ resetStatus()

void KviHttpRequest::resetStatus ( )
private

◆ resolvingHost

void KviHttpRequest::resolvingHost ( const QString & hostname)
signal

Referenced by doConnect().

◆ setConnectionTimeout()

void KviHttpRequest::setConnectionTimeout ( unsigned int uConnectionTimeout)
inline

References m_uConnectionTimeout.

Referenced by http_kvs_complete_get().

◆ setContentOffset()

void KviHttpRequest::setContentOffset ( int uContentOffset)
inline

References m_uContentOffset.

Referenced by http_kvs_complete_get().

◆ setExistingFileAction()

void KviHttpRequest::setExistingFileAction ( ExistingFileAction a)
inline

References a, and m_eExistingFileAction.

Referenced by http_kvs_complete_get().

◆ setFileName()

void KviHttpRequest::setFileName ( const QString & szFileName)
inline

References m_szFileName.

Referenced by get(), and http_kvs_complete_get().

◆ setFollowRedirects()

void KviHttpRequest::setFollowRedirects ( bool bFollow)
inline

References m_bFollowRedirects.

◆ setMaxContentLength()

void KviHttpRequest::setMaxContentLength ( int uMaxContentLength)
inline

References m_uMaxContentLength.

Referenced by http_kvs_complete_get().

◆ setMaximumRedirectCount()

void KviHttpRequest::setMaximumRedirectCount ( unsigned int uCount)
inline

◆ setPostData()

void KviHttpRequest::setPostData ( const QString & szPostData)
inline

References m_szPostData.

Referenced by http_kvs_complete_get().

◆ setPrivateData()

void KviHttpRequest::setPrivateData ( void * ptr)
inline

References m_pPrivateData.

◆ setProcessingType()

void KviHttpRequest::setProcessingType ( ProcessingType t)
inline

References m_eProcessingType, and t.

Referenced by get(), and http_kvs_complete_get().

◆ setUrl()

void KviHttpRequest::setUrl ( const KviUrl & u)
inline

References m_connectionUrl, m_url, and u.

Referenced by get(), and http_kvs_complete_get().

◆ slotConnectionTimedOut

void KviHttpRequest::slotConnectionTimedOut ( )
privateslot

◆ slotSocketConnected

◆ slotSocketDisconnected

◆ slotSocketError

void KviHttpRequest::slotSocketError ( QAbstractSocket::SocketError socketError)
privateslot

◆ slotSocketHostResolved

void KviHttpRequest::slotSocketHostResolved ( )
privateslot

◆ slotSocketReadDataReady

void KviHttpRequest::slotSocketReadDataReady ( )
privateslot

◆ start()

◆ status

void KviHttpRequest::status ( const QString & message)
signal

◆ terminated

void KviHttpRequest::terminated ( bool bSuccess)
signal

◆ totalSize()

unsigned int KviHttpRequest::totalSize ( )
inline

References m_uTotalSize.

◆ url()

const KviUrl & KviHttpRequest::url ( )
inline

References m_url.

Referenced by processHeader().

Member Data Documentation

◆ m_bChunkedTransferEncoding

bool KviHttpRequest::m_bChunkedTransferEncoding
protected

◆ m_bFollowRedirects

bool KviHttpRequest::m_bFollowRedirects
protected

◆ m_bGzip

bool KviHttpRequest::m_bGzip
protected

Referenced by processHeader(), and resetData().

◆ m_bHeaderProcessed

bool KviHttpRequest::m_bHeaderProcessed
protected

◆ m_bIgnoreRemainingData

bool KviHttpRequest::m_bIgnoreRemainingData
protected

Referenced by processData(), and resetData().

◆ m_connectionUrl

KviUrl KviHttpRequest::m_connectionUrl
protected

◆ m_eExistingFileAction

ExistingFileAction KviHttpRequest::m_eExistingFileAction
protected

◆ m_eProcessingType

◆ m_p

◆ m_pPrivateData

void* KviHttpRequest::m_pPrivateData
protected

◆ m_szFileName

QString KviHttpRequest::m_szFileName
protected

◆ m_szLastError

◆ m_szPostData

QString KviHttpRequest::m_szPostData
protected

Referenced by setPostData(), and slotSocketConnected().

◆ m_uConnectionTimeout

unsigned int KviHttpRequest::m_uConnectionTimeout
protected

◆ m_uContentOffset

unsigned int KviHttpRequest::m_uContentOffset
protected

◆ m_uMaxContentLength

unsigned int KviHttpRequest::m_uMaxContentLength
protected

◆ m_uMaximumRedirectCount

unsigned int KviHttpRequest::m_uMaximumRedirectCount
protected

◆ m_uReceivedSize

unsigned int KviHttpRequest::m_uReceivedSize
protected

◆ m_uRedirectCount

unsigned int KviHttpRequest::m_uRedirectCount
protected

◆ m_uRemainingChunkSize

unsigned int KviHttpRequest::m_uRemainingChunkSize
protected

◆ m_url

KviUrl KviHttpRequest::m_url
protected

Referenced by processHeader(), resetData(), setUrl(), and url().

◆ m_uTotalSize

unsigned int KviHttpRequest::m_uTotalSize
protected

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