ttv::StandardFileSocket Class Reference

#include <standardfilesocket.h>

Inheritance diagram for ttv::StandardFileSocket:

Public Member Functions
	StandardFileSocket ()
virtual	~StandardFileSocket ()
TTV_ErrorCode	Initialize (const std::string &inputPath, const std::string &outputPath)
virtual TTV_ErrorCode	Connect ()
virtual TTV_ErrorCode	Disconnect ()
virtual TTV_ErrorCode	Send (const uint8_t *buffer, size_t length, size_t &sent)
virtual TTV_ErrorCode	Recv (uint8_t *buffer, size_t length, size_t &received)
virtual uint64_t	TotalSent ()
virtual uint64_t	TotalReceived ()
virtual bool	Connected ()
virtual TTV_ErrorCode	Send (const uint8_t *buffer, size_t length)

Private Attributes
std::string	mInputFilePath
std::string	mOutputFilePath
FILE *	mInputFile
FILE *	mOutputFile
uint64_t	mTotalSent
uint64_t	mTotalRecieved
bool	mConnected

Constructor & Destructor Documentation

StandardFileSocket()

ttv::StandardFileSocket::StandardFileSocket

(

)

~StandardFileSocket()

virtual ttv::StandardFileSocket::~StandardFileSocket ( )

virtual

Member Function Documentation

Connect()

virtual TTV_ErrorCode ttv::StandardFileSocket::Connect ( )

virtual

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::StandardFileSocket::Connected ( )

virtual

Determines if the socket is currently connected.

Returns

Whether or not currently connected.

Implements ttv::ISocket.

Disconnect()

virtual TTV_ErrorCode ttv::StandardFileSocket::Disconnect ( )

virtual

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.

Initialize()

TTV_ErrorCode ttv::StandardFileSocket::Initialize	(	const std::string &	inputPath,
		const std::string &	outputPath
	)

Recv()

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

virtual

Attempts to receive some bytes from the socket.

Parameters

[in]	buffer	The buffer to store the received bytes in.
[in]	length	The largest number of bytes to receive.
[out]	received	The 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::StandardFileSocket::Send ( const uint8_t *  buffer, size_t  length, size_t &  sent  )

virtual

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]	buffer	The buffer to store the received bytes in.
[in]	length	The number of bytes to send.
[out]	sent	The 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]	buffer	The buffer to store the received bytes in.
[in]	length	The 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::StandardFileSocket::TotalReceived ( )

virtual

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::StandardFileSocket::TotalSent ( )

virtual

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

mConnected

bool ttv::StandardFileSocket::mConnected

private

mInputFile

FILE* ttv::StandardFileSocket::mInputFile

private

mInputFilePath

std::string ttv::StandardFileSocket::mInputFilePath

private

mOutputFile

FILE* ttv::StandardFileSocket::mOutputFile

private

mOutputFilePath

std::string ttv::StandardFileSocket::mOutputFilePath

private

mTotalRecieved

uint64_t ttv::StandardFileSocket::mTotalRecieved

private

mTotalSent

uint64_t ttv::StandardFileSocket::mTotalSent

private

---

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

• modules/core/core_std/include/twitchsdk/core/standardfilesocket.h