FreeRTOSTCP Class Reference

Provides the startup and mantainance methods for configuring and using the FreeRTOSTCP stack. More...

#include <FreeRTOSTCP.hxx>

Inheritance diagram for FreeRTOSTCP:

Public Member Functions
	FreeRTOSTCP ()
	Constructor.
	~FreeRTOSTCP ()
	Destructor.
void	start ()
	Startup the networking processes.

Private Member Functions
void	net_task ()
	Thread that will manage the net connection inside object context.
void	select_wakeup (Socket_t data=nullptr)
	Asynchronously wakeup the select call.
void	fd_set_read (Socket_t socket)
	Add socket to the read fd set.
void	fd_set_write (Socket_t socket)
	Add socket to the write fd set.
	DISALLOW_COPY_AND_ASSIGN (FreeRTOSTCP)

Static Private Member Functions
static void *	net_task_entry (void *context)
	Thread that will manage the network connection.

Private Attributes
uint32_t	ipAddress
	assigned IP adress
Socket_t	wakeup
	signal socket to wakeup select()

Static Private Attributes
static FreeRTOSTCP *	instance_
	singleton instance pointer.

Friends
class	FreeRTOSTCPSocket
	allow access to private members from CC32xxSocket

Additional Inherited Members
Static Public Member Functions inherited from Singleton< FreeRTOSTCP >
static FreeRTOSTCP *	instance ()
static bool	exists ()

Detailed Description

Provides the startup and mantainance methods for configuring and using the FreeRTOSTCP stack.

This is designed to be a singleton. It should only be instantiated once.

Definition at line 50 of file FreeRTOSTCP.hxx.

Constructor & Destructor Documentation

FreeRTOSTCP()

FreeRTOSTCP::FreeRTOSTCP

(

)

Constructor.

Definition at line 65 of file FreeRTOSTCP.cxx.

~FreeRTOSTCP()

FreeRTOSTCP::~FreeRTOSTCP ( )

inline

Destructor.

Definition at line 59 of file FreeRTOSTCP.hxx.

Member Function Documentation

fd_set_read()

void FreeRTOSTCP::fd_set_read ( Socket_t  socket )

private

Add socket to the read fd set.

Parameters

socket

socket descriptor to add

Definition at line 243 of file FreeRTOSTCP.cxx.

fd_set_write()

void FreeRTOSTCP::fd_set_write ( Socket_t  socket )

private

Add socket to the write fd set.

Parameters

socket

socket descriptor to add

Definition at line 252 of file FreeRTOSTCP.cxx.

net_task()

void FreeRTOSTCP::net_task ( )

private

Thread that will manage the net connection inside object context.

Definition at line 84 of file FreeRTOSTCP.cxx.

net_task_entry()

static void * FreeRTOSTCP::net_task_entry ( void *  context )

inlinestaticprivate

Thread that will manage the network connection.

Parameters

context

context passed into the stack.

Definition at line 71 of file FreeRTOSTCP.hxx.

select_wakeup()

void FreeRTOSTCP::select_wakeup ( Socket_t  data = nullptr )

private

Asynchronously wakeup the select call.

Parameters

data	-1 for no action, else socket descriptor if socket shall be closed.

Definition at line 223 of file FreeRTOSTCP.cxx.

start()

void FreeRTOSTCP::start

(

)

Startup the networking processes.

Definition at line 74 of file FreeRTOSTCP.cxx.

Friends And Related Symbol Documentation

FreeRTOSTCPSocket

friend class FreeRTOSTCPSocket

friend

allow access to private members from CC32xxSocket

Definition at line 103 of file FreeRTOSTCP.hxx.

Member Data Documentation

instance_

FreeRTOSTCP* FreeRTOSTCP::instance_

staticprivate

singleton instance pointer.

Definition at line 97 of file FreeRTOSTCP.hxx.

ipAddress

uint32_t FreeRTOSTCP::ipAddress

private

assigned IP adress

Definition at line 98 of file FreeRTOSTCP.hxx.

wakeup

Socket_t FreeRTOSTCP::wakeup

private

signal socket to wakeup select()

Definition at line 100 of file FreeRTOSTCP.hxx.

---

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

• FreeRTOSTCP.hxx
• FreeRTOSTCP.cxx