libDwmAuth-0.3.6
Dwm::Auth::SymCrypto::Message Class Reference

Encapsulates an encrypted message. More...

#include <DwmAuthSymCryptoMessage.hh>

Inherits DescriptorIOCapable, FileIOCapable, StreamIOCapable, and StreamedLengthCapable.

Public Member Functions

 Message (const std::string &secret, const std::string &value="")
 Constructor with the given secret and value.
 
 ~Message ()
 Destructor.
 
std::string Value () const
 Returns the decrypted value.
 
const std::string & Value (const std::string &value)
 Sets the contained value by encrypting the given value.
 
std::istream & Read (std::istream &is) override
 Reads the message from an istream. Returns the istream.
 
std::ostream & Write (std::ostream &os) const override
 Writes the message to an ostream. Returns the ostream.
 
ssize_t Read (int fd) override
 Reads the message from a file descriptor. More...
 
ssize_t Write (int fd) const override
 Writes the message to a file descriptor. More...
 
size_t Read (FILE *f) override
 Reads the message from a FILE. More...
 
size_t Write (FILE *f) const override
 Writes the message to a FILE. More...
 
uint32_t StreamedLength () const override
 Returns the number of bytes that would be written if one of the Write() members were called. More...
 
ssize_t SendTo (Socket &s, int flags, const Ipv4Address &dstAddr, uint16_t dstPort)
 
ssize_t RecvFrom (Socket &s, int flags, Ipv4Address &srcAddr, uint16_t &srcPort)
 

Detailed Description

Encapsulates an encrypted message.

Member Function Documentation

◆ Read() [1/2]

ssize_t Dwm::Auth::SymCrypto::Message::Read ( int  fd)
override

Reads the message from a file descriptor.

Returns the numbers of bytes read on success, -1 on failure.

◆ Read() [2/2]

size_t Dwm::Auth::SymCrypto::Message::Read ( FILE *  f)
override

Reads the message from a FILE.

Returns 1 on success, 0 on failure.

◆ StreamedLength()

uint32_t Dwm::Auth::SymCrypto::Message::StreamedLength ( ) const
override

Returns the number of bytes that would be written if one of the Write() members were called.

◆ Write() [1/2]

ssize_t Dwm::Auth::SymCrypto::Message::Write ( int  fd) const
override

Writes the message to a file descriptor.

Returns the number of bytes written on success, -1 on failure.

◆ Write() [2/2]

size_t Dwm::Auth::SymCrypto::Message::Write ( FILE *  f) const
override

Writes the message to a FILE.

Returns 1 on success, 0 on failure.


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