KIMAP2::ImapStreamParser

Search for usage in LXR

KIMAP2::ImapStreamParser Class Reference

#include <imapstreamparser.h>

Public Member Functions

 ImapStreamParser (QIODevice *socket, bool serverModeEnabled=false)
 
int availableDataSize () const
 
QByteArray currentBuffer () const
 
bool error () const
 
void onResponseReceived (std::function< void(const Message &)>)
 
void parseStream ()
 
QByteArray readUntilCommandEnd ()
 

Detailed Description

Parser for IMAP messages that operates on a local socket stream.

Definition at line 41 of file imapstreamparser.h.

Constructor & Destructor Documentation

◆ ImapStreamParser()

ImapStreamParser::ImapStreamParser ( QIODevice * socket,
bool serverModeEnabled = false )
explicit

Construct the parser.

Parameters
socketthe local socket to work with.
serverModeEnabledtrue if the parser has to assume we're writing a server (e.g. sends continuation message automatically)

Definition at line 33 of file imapstreamparser.cpp.

Member Function Documentation

◆ availableDataSize()

int ImapStreamParser::availableDataSize ( ) const

Definition at line 431 of file imapstreamparser.cpp.

◆ currentBuffer()

QByteArray ImapStreamParser::currentBuffer ( ) const

Definition at line 479 of file imapstreamparser.cpp.

◆ error()

bool ImapStreamParser::error ( ) const

Definition at line 474 of file imapstreamparser.cpp.

◆ onResponseReceived()

void ImapStreamParser::onResponseReceived ( std::function< void(const Message &)> f)

Definition at line 469 of file imapstreamparser.cpp.

◆ parseStream()

void ImapStreamParser::parseStream ( )

Definition at line 379 of file imapstreamparser.cpp.

◆ readUntilCommandEnd()

QByteArray ImapStreamParser::readUntilCommandEnd ( )

Return everything that remained from the command.

Returns
the remaining command data

Definition at line 436 of file imapstreamparser.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:21:18 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.