Twitch SDK (Internal)
Public Member Functions | Private Attributes | List of all members
ttv::CFSocket Class Reference

#include <cfsocket.h>

Inheritance diagram for ttv::CFSocket:
ttv::ISocket

Public Member Functions

 CFSocket (const std::string &host, uint32_t port, bool useSsl)
 
virtual ~CFSocket ()
 
virtual TTV_ErrorCode Connect () override
 
virtual TTV_ErrorCode Disconnect () override
 
virtual TTV_ErrorCode Send (const uint8_t *buffer, size_t length, size_t &sent) override
 
virtual TTV_ErrorCode Recv (uint8_t *buffer, size_t length, size_t &received) override
 
virtual uint64_t TotalSent () override
 
virtual uint64_t TotalReceived () override
 
virtual bool Connected () override
 
virtual TTV_ErrorCode Send (const uint8_t *buffer, size_t length)
 

Private Attributes

std::string mHostName
 
uint32_t mPort
 
uint64_t mTotalSent
 
uint64_t mTotalReceived
 
bool mUseSsl
 
CFReadStreamRef mReadStream
 
CFWriteStreamRef mWriteStream
 

Constructor & Destructor Documentation

◆ CFSocket()

ttv::CFSocket::CFSocket ( const std::string &  host,
uint32_t  port,
bool  useSsl 
)

◆ ~CFSocket()

virtual ttv::CFSocket::~CFSocket ( )
virtual

Member Function Documentation

◆ Connect()

virtual TTV_ErrorCode ttv::CFSocket::Connect ( )
overridevirtual

Synchronously connects to the endpoint.

See also
Disconnect
Returns
  • TTV_EC_SUCCESS: The socket has successfully connected and is ready to exchange data.
  • TTV_EC_SOCKET_EALREADY: Already connected.
  • TTV_EC_SOCKET_ETIMEDOUT: The connection timed out.
  • TTV_EC_SOCKET_ERR: A generic error occurred.

Implements ttv::ISocket.

◆ Connected()

virtual bool ttv::CFSocket::Connected ( )
overridevirtual

Determines if the socket is currently connected.

Returns
Whether or not currently connected.

Implements ttv::ISocket.

◆ Disconnect()

virtual TTV_ErrorCode ttv::CFSocket::Disconnect ( )
overridevirtual

Synchronously disconnects from the endpoint. It is safe to call Disconnect() if not connected.

See also
Connect
Returns
  • TTV_EC_SUCCESS: The socket has successfully disconnected.
  • TTV_EC_SOCKET_ERR: A generic error occurred.

Implements ttv::ISocket.

◆ Recv()

virtual TTV_ErrorCode ttv::CFSocket::Recv ( uint8_t *  buffer,
size_t  length,
size_t &  received 
)
overridevirtual

Attempts to receive some bytes from the socket.

Parameters
[in]bufferThe buffer to store the received bytes in.
[in]lengthThe largest number of bytes to receive.
[out]receivedThe number of bytes actually received.
Returns
  • TTV_EC_SUCCESS: Some bytes have been received.
  • TTV_EC_SOCKET_EWOULDBLOCK: The socket is connected but there aren't any bytes available to be read.
  • TTV_EC_SOCKET_ENOTCONN: The socket is not connected.
  • TTV_EC_SOCKET_ECONNABORTED: The connected was dropped.
  • TTV_EC_SOCKET_ETIMEDOUT: The connection timed out.
  • TTV_EC_SOCKET_ECONNRESET: The connection was closed by the remote host.
  • TTV_EC_SOCKET_ERR: A generic error occurred.

Implements ttv::ISocket.

◆ Send() [1/2]

virtual TTV_ErrorCode ttv::CFSocket::Send ( const uint8_t *  buffer,
size_t  length,
size_t &  sent 
)
overridevirtual

Attempts to send some bytes over the socket. It's possible that the socket is unable to send able to send any more bytes right now but will be in the near future. Thus, the number actually sent may be less than the size of the passed in buffer.

Parameters
[in]bufferThe buffer to store the received bytes in.
[in]lengthThe number of bytes to send.
[out]sentThe number of bytes actually sent.
Returns
  • TTV_EC_SUCCESS: Some bytes have been sent.
  • TTV_EC_SOCKET_EWOULDBLOCK: The socket is connected but wasn't able to send any bytes right now.
  • TTV_EC_SOCKET_ENOTCONN: The socket is not connected.
  • TTV_EC_SOCKET_ECONNABORTED: The connected was dropped.
  • TTV_EC_SOCKET_ETIMEDOUT: The connection timed out.
  • TTV_EC_SOCKET_ECONNRESET: The connection was closed by the remote host.
  • TTV_EC_SOCKET_ERR: A generic error occurred.

Implements ttv::ISocket.

◆ Send() [2/2]

virtual TTV_ErrorCode ttv::ISocket::Send ( const uint8_t *  buffer,
size_t  length 
)
virtualinherited

Attempts to send some bytes over the socket. This flavor of Send() is a helper which guarantees that all bytes are sent or where is an error on the socket.

Parameters
[in]bufferThe buffer to store the received bytes in.
[in]lengthThe number of bytes to send.
Returns
  • TTV_EC_SUCCESS: The bytes have been sent.
  • TTV_EC_SOCKET_ENOTCONN: The socket is not connected.
  • TTV_EC_SOCKET_ECONNABORTED: The connected was dropped.
  • TTV_EC_SOCKET_ETIMEDOUT: The connection timed out.
  • TTV_EC_SOCKET_ECONNRESET: The connection was closed by the remote host.
  • TTV_EC_SOCKET_ERR: A generic error occurred.

Reimplemented in ttv::WinAppSocket.

◆ TotalReceived()

virtual uint64_t ttv::CFSocket::TotalReceived ( )
overridevirtual

Returns the total number of bytes that have been received from the socket during the current connection.

Returns
The number of bytes received during the current connection.

Implements ttv::ISocket.

◆ TotalSent()

virtual uint64_t ttv::CFSocket::TotalSent ( )
overridevirtual

Returns the total number of bytes that have been sent over the socket during the current connection.

Returns
The number of bytes sent during the current connection.

Implements ttv::ISocket.

Member Data Documentation

◆ mHostName

std::string ttv::CFSocket::mHostName
private

◆ mPort

uint32_t ttv::CFSocket::mPort
private

◆ mReadStream

CFReadStreamRef ttv::CFSocket::mReadStream
private

◆ mTotalReceived

uint64_t ttv::CFSocket::mTotalReceived
private

◆ mTotalSent

uint64_t ttv::CFSocket::mTotalSent
private

◆ mUseSsl

bool ttv::CFSocket::mUseSsl
private

◆ mWriteStream

CFWriteStreamRef ttv::CFSocket::mWriteStream
private
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13