Home About us GitHub Contact us Docs

FoxOS

Welcome to the FoxOS website!

tcp_handler::tcp_handler

Signature: tcp_handler::tcp_handler()
Attributes: undefined
Description: Constructor for the tcp handler class

tcp_handler::~tcp_handler

Signature: tcp_handler::~tcp_handler()
Attributes: undefined
Description: Destructor for the tcp handler class

tcp_handler::on_tcp_message

Signature: bool tcp_handler::on_tcp_message(tcp_socket* socket, uint8_t* data, size_t size)
Description: Handles a TCP message

Parameters:

Return: bool

tcp_socket::tcp_socket

Signature: tcp_socket::tcp_socket(tcp_provider* provider): acknowledged(1)
Attributes: undefined
Description: Constructor for the tcp socket class

Parameters:

tcp_socket::~tcp_socket

Signature: tcp_socket::~tcp_socket()
Attributes: undefined
Description: Destructor for the tcp socket class

tcp_socket::handle_tcp_message

Signature: bool tcp_socket::handle_tcp_message(uint8_t* data, size_t size)
Description: Handles a TCP message

Parameters:

Return: bool

tcp_socket::send

Signature: void tcp_socket::send(uint8_t* data, size_t size)
Description: Sends a TCP message

Parameters:

Return: void

tcp_socket::disconnect

Signature: void tcp_socket::disconnect()
Description: Disconnects the socket

Return: void

tcp_provider::tcp_provider

Signature: tcp_provider::tcp_provider(ipv4_provider *ipv4_provider): ipv4_handler(ipv4_provider, 0x06), binds(100)
Attributes: undefined
Description: Constructor for the tcp provider class

Parameters:

tcp_provider::on_internet_protocol_received

Signature: bool tcp_provider::on_internet_protocol_received(uint32_t srcIP_BE, uint32_t dstIP_BE, uint8_t* payload, uint32_t size)
Description: Handles an IPv4 packet

Parameters:

Return: bool

tcp_provider::connect

Signature: tcp_socket* tcp_provider::connect(uint32_t ip, uint16_t port)
Description: Connects to a host

Parameters:

Return: tcp_socket*

tcp_provider::listen

Signature: tcp_socket* tcp_provider::listen(uint16_t port)
Description: Listens for incoming connections

Parameters:

Return: tcp_socket*

tcp_provider::disconnect

Signature: void tcp_provider::disconnect(tcp_socket* socket)
Description: Disconnects the socket

Parameters:

Return: void

tcp_provider::send

Signature: void tcp_provider::send(tcp_socket* socket, uint8_t* data, size_t size, uint16_t flags)
Description: Sends a TCP message

Parameters:

Return: void

tcp_provider::retransmit

Signature: void tcp_provider::retransmit(tcp_socket* socket, uint8_t* packet, size_t size, list::node* list_node)
Description: Retransmits a TCP message

Parameters:

Return: void

tcp_provider::bind

Signature: void tcp_provider::bind(tcp_socket* socket, tcp_handler* handler)
Description: Binds the socket to a port

Parameters:

Return: void

Show file on GitHub