SsdpMessage.hpp

This File On Github
Ask A Question

API: latest
module: oatpp-ssdp
#include "oatpp-ssdp/SsdpMessage.hpp"

SsdpMessage

Class Adaptor, representing a single SSDP message.

namespace oatpp { namespace ssdp { 
  class SsdpMessage : public base::Countable, public data::stream::IOStream {}
}}

Methods

Return Type Name Summary
[none] SsdpMessage Constructor.
v_io_size flushToStream This flushes the buffered data to any other stream.
v_io_size flush This flushes the buffered data to the given input stream
v_io_size write Implementation of oatpp::data::stream::IOStream::write.
v_io_size read Implementation of oatpp::data::stream::IOStream::read.
void setOutputStreamIOMode Set OutputStream I/O mode.
oatpp::data::stream::IOMode getOutputStreamIOMode Set OutputStream I/O mode.
oatpp::data::stream::Context& getOutputStreamContext Get output stream context.
void setInputStreamIOMode Set InputStream I/O mode.
oatpp::data::stream::IOMode getInputStreamIOMode Get InputStream I/O mode.
oatpp::data::stream::Context& getInputStreamContext Get input stream context.

SsdpMessage::SsdpMessage

Constructor.

  • @param incomingStream

SsdpMessage(const std::shared_ptr<IOStream>& incomingStream)

SsdpMessage::flushToStream

This flushes the buffered data to any other stream.

v_io_size flushToStream(OutputStream* stream)

SsdpMessage::flush

This flushes the buffered data to the given input stream

v_io_size flush()

SsdpMessage::write

Implementation of oatpp::data::stream::IOStream::write.

  • @param buff - buffer containing data to write.
  • @param count - bytes count you want to write.
  • @param action - async specific action. If action is NOT oatpp::async::Action::TYPE_NONE, then caller MUST return this action on coroutine iteration.
  • @return - actual amount of bytes written. See oatpp::v_io_size.

v_io_size write(const void *buff, v_buff_size count, async::Action& action) override

SsdpMessage::read

Implementation of oatpp::data::stream::IOStream::read.

  • @param buff - buffer to read data to.
  • @param count - buffer size.
  • @param action - async specific action. If action is NOT oatpp::async::Action::TYPE_NONE, then caller MUST return this action on coroutine iteration.
  • @return - actual amount of bytes read. See oatpp::v_io_size.

v_io_size read(void *buff, v_buff_size count, async::Action& action) override

SsdpMessage::setOutputStreamIOMode

Set OutputStream I/O mode.

  • @param ioMode

void setOutputStreamIOMode(oatpp::data::stream::IOMode ioMode) override

SsdpMessage::getOutputStreamIOMode

Set OutputStream I/O mode.

  • @return

oatpp::data::stream::IOMode getOutputStreamIOMode() override

SsdpMessage::getOutputStreamContext

Get output stream context.

oatpp::data::stream::Context& getOutputStreamContext() override

SsdpMessage::setInputStreamIOMode

Set InputStream I/O mode.

  • @param ioMode

void setInputStreamIOMode(oatpp::data::stream::IOMode ioMode) override

SsdpMessage::getInputStreamIOMode

Get InputStream I/O mode.

  • @return

oatpp::data::stream::IOMode getInputStreamIOMode() override

SsdpMessage::getInputStreamContext

Get input stream context.

oatpp::data::stream::Context& getInputStreamContext() override