KLDAPCore::Ber Class

Header: #include <KLDAPCore/Ber>
CMake: find_package(KPim6LdapCore REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::LdapCore)

Public Functions

Ber()
Ber(const QByteArray &value)
~Ber()
QByteArray flatten() const
unsigned int peekTag(int &size)
int printf(QString format, ...)
int scanf(QString format, ...)
unsigned int skipTag(int &size)
KLDAPCore::Ber &operator=(const KLDAPCore::Ber &that)

Detailed Description

This class allows encoding and decoding Qt structures using Basic Encoding Rules.

Member Function Documentation

Ber::Ber()

Constructs a Ber object.

[explicit] Ber::Ber(const QByteArray &value)

Constructs a Ber object from the given value. value the QByteArray value to initialize from

[noexcept] Ber::~Ber()

Destroys the Ber object.

QByteArray Ber::flatten() const

Returns the Ber object as a flat QByteArray. Returns the encoded QByteArray

unsigned int Ber::peekTag(int &size)

Peeks at the next tag without removing it. size the size of the tag (output parameter) Returns the tag value

int Ber::printf(QString format, ...)

Appends the data with the specified format to the Ber object. This function works like printf, except that it's appending the parameters, not replacing them. The allowed format characters and the expected parameter types are: <ul> <li> b Boolean. An int parameter should be supplied. A boolean element is output. </li> <li> e Enumeration. An int parameter should be supplied. An enumeration element is output. </li> <li> i Integer. An int parameter should be supplied. An integer element is output. </li> <li> B Bitstring. A pointer to a QByteArray which contains the bitstring is supplied, followed by the number of bits in the bitstring. A bitstring element is output. </li> <li> n Null. No parameter is required. A null element is output. </li> <li> O,o,s Octet string. A QByteArray * is supplied. An octet string element is output. Due to versatility of Qt's QByteArray, these three format strings are all accepts the same parameter, but using the 's' format the string will be encoded only to the first zero character (a null terminated string)! </li> <li> t Tag. An int specifying the tag to give the next element is provided. This works across calls. </li> <li> v,V Several octet strings. A QList<QByteArray>* is supplied. Note that a construct like ’{v}’ is required to get an actual SEQUENCE OF octet strings. Also note that the 'v' format recognizes the QByteArray only to the first zero character, so it's not appropriate for binary data, just only for null terminated strings! </li> <li> { Begin sequence. No parameter is required. </li> <li> } End sequence. No parameter is required. </li> <li> [ Begin set. No parameter is required. </li> <li> ] End set. No parameter is required. </li> </ul> format the format string Returns the number of bytes appended

int Ber::scanf(QString format, ...)

Scans from the Ber object according to the given format string. format the format string Returns the number of bytes scanned

unsigned int Ber::skipTag(int &size)

Skips the next tag. size the size of the tag (output parameter) Returns the tag value

KLDAPCore::Ber &Ber::operator=(const KLDAPCore::Ber &that)

Assigns the given Ber object to this object. that the Ber object to assign Returns a reference to this object