Connection.hpp

This File On Github
Ask A Question

API: latest
module: oatpp
#include "oatpp/network/Connection.hpp"

Connection

TCP Connection implementation. Extends oatpp::base::Countable and oatpp::data::stream::IOStream.

namespace oatpp { namespace network { 
  class Connection : public oatpp::base::Countable, public oatpp::data::stream::IOStream {}
}}

Methods

Return Type Name Summary
[none] Connection Constructor.
std::shared_ptr<Connection> createShared Create shared Connection.
[none] ~Connection Virtual Destructor (See oatpp::base::Countable).
data::v_io_size write Implementation of oatpp::data::stream::IOStream::write.
data::v_io_size read Implementation of oatpp::data::stream::IOStream::read.
oatpp::async::Action suggestOutputStreamAction Implementation of OutputStream must suggest async actions for I/O results.
oatpp::async::Action suggestInputStreamAction Implementation of InputStream must suggest async actions for I/O results.
void setOutputStreamIOMode Set OutputStream I/O mode.
oatpp::data::stream::IOMode getOutputStreamIOMode Set OutputStream I/O mode.
void setInputStreamIOMode Set InputStream I/O mode.
oatpp::data::stream::IOMode getInputStreamIOMode Get InputStream I/O mode.
void close Close socket handle.
data::v_io_handle getHandle Get socket handle.

Connection::Connection

Constructor.

  • @param handle - file descriptor (socket handle). See oatpp::data::v_io_handle.

Connection(data::v_io_handle handle)

Connection::createShared

Create shared Connection.

  • @param handle - file descriptor (socket handle). See oatpp::data::v_io_handle.
  • @return - shared_ptr to Connection.

static std::shared_ptr<Connection> createShared(data::v_io_handle handle)

Connection::~Connection

Virtual Destructor (See oatpp::base::Countable). Close socket handle.

~Connection()

Connection::write

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

  • @param buff - buffer containing data to write.
  • @param count - bytes count you want to write.
  • @return - actual amount of bytes written. See oatpp::data::v_io_size.

data::v_io_size write(const void *buff, data::v_io_size count) override

Connection::read

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

  • @param buff - buffer to read data to.
  • @param count - buffer size.
  • @return - actual amount of bytes read. See oatpp::data::v_io_size.

data::v_io_size read(void *buff, data::v_io_size count) override

Connection::suggestOutputStreamAction

Implementation of OutputStream must suggest async actions for I/O results. Suggested Action is used for scheduling coroutines in async::Executor.

oatpp::async::Action suggestOutputStreamAction(data::v_io_size ioResult) override

Connection::suggestInputStreamAction

Implementation of InputStream must suggest async actions for I/O results. Suggested Action is used for scheduling coroutines in async::Executor.

oatpp::async::Action suggestInputStreamAction(data::v_io_size ioResult) override

Connection::setOutputStreamIOMode

Set OutputStream I/O mode.

  • @param ioMode

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

Connection::getOutputStreamIOMode

Set OutputStream I/O mode.

  • @return

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

Connection::setInputStreamIOMode

Set InputStream I/O mode.

  • @param ioMode

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

Connection::getInputStreamIOMode

Get InputStream I/O mode.

  • @return

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

Connection::close

Close socket handle.

void close()

Connection::getHandle

Get socket handle.

  • @return - socket handle. oatpp::data::v_io_handle.

data::v_io_handle getHandle()