libpromeki/main/tcpsocket_8h_source.html

#pragma once


#include <promeki/network/abstractsocket.h>


PROMEKI_NAMESPACE_BEGIN


class TcpSocket : public AbstractSocket {

        PROMEKI_OBJECT(TcpSocket, AbstractSocket)

        public:

                TcpSocket(ObjectBase *parent = nullptr);


                ~TcpSocket() override;


                Error open(OpenMode mode) override;


                Error openIpv6(OpenMode mode);


                Error close() override;


                bool isOpen() const override { return _fd >= 0; }


                int64_t read(void *data, int64_t maxSize) override;


                int64_t write(const void *data, int64_t maxSize) override;


                int64_t bytesAvailable() const override;


                Error setNoDelay(bool enable);


                Error setKeepAlive(bool enable);

};


PROMEKI_NAMESPACE_END

abstractsocket.h

AbstractSocket
Abstract base class for network sockets.
Definition abstractsocket.h:38

AbstractSocket::_fd
int _fd
Socket file descriptor.
Definition abstractsocket.h:203

Error
Lightweight error code wrapper for the promeki library.
Definition error.h:39

IODevice::OpenMode
OpenMode
Mode flags controlling how a device is opened.
Definition iodevice.h:33

List
Dynamic array container wrapping std::vector.
Definition list.h:40

ObjectBase
Base object for promeki.
Definition objectbase.h:129

ObjectBase::parent
ObjectBase * parent() const
Returns the parent object, if one. nullptr if none.
Definition objectbase.h:258

TcpSocket
Stream-oriented TCP socket.
Definition tcpsocket.h:35

TcpSocket::open
Error open(OpenMode mode) override
Opens the socket.

TcpSocket::read
int64_t read(void *data, int64_t maxSize) override
Reads data from the connected socket.

TcpSocket::setNoDelay
Error setNoDelay(bool enable)
Enables or disables TCP_NODELAY (Nagle algorithm).

TcpSocket::setKeepAlive
Error setKeepAlive(bool enable)
Enables or disables SO_KEEPALIVE.

TcpSocket::write
int64_t write(const void *data, int64_t maxSize) override
Writes data to the connected socket.

TcpSocket::TcpSocket
TcpSocket(ObjectBase *parent=nullptr)
Constructs a TcpSocket.

TcpSocket::bytesAvailable
int64_t bytesAvailable() const override
Returns the number of bytes available for reading.

TcpSocket::~TcpSocket
~TcpSocket() override
Destructor.

TcpSocket::openIpv6
Error openIpv6(OpenMode mode)
Opens the socket for IPv6 operation.

TcpSocket::isOpen
bool isOpen() const override
Returns true if the socket is open.
Definition tcpsocket.h:76

TcpSocket::close
Error close() override
Closes the socket.

PROMEKI_NAMESPACE_BEGIN
#define PROMEKI_NAMESPACE_BEGIN
Starts a promeki namespace block.
Definition namespace.h:14

PROMEKI_NAMESPACE_END
#define PROMEKI_NAMESPACE_END
Ends a promeki namespace block.
Definition namespace.h:19