PyPicoScenes.hxx File Reference

#include <string>
#include "AbstractNIC.hxx"

Include dependency graph for PyPicoScenes.hxx:

Go to the source code of this file.

Functions
void	PicoScenesStart () noexcept
	Initializes and starts the PicoScenes platform.
void	PicoScenesStop () noexcept
	Stops the PicoScenes platform.
void	PicoScenesWait () noexcept
	Blocks the current thread until PicoScenes is stopped.
std::shared_ptr< AbstractNIC >	getNIC (std::string nicName) noexcept
	Retrieves a network interface controller by name.

Function Documentation

getNIC()

std::shared_ptr< AbstractNIC > getNIC ( std::string  nicName )

noexcept

Retrieves a network interface controller by name.

This function returns a shared pointer to an AbstractNIC object representing the network interface controller with the specified name.

Parameters

nicName

The name of the network interface controller to retrieve

Returns

std::shared_ptr<AbstractNIC> A shared pointer to the requested NIC

PicoScenesStart()

void PicoScenesStart ( )

noexcept

Initializes and starts the PicoScenes platform.

This function initializes the PicoScenes platform, sets up necessary services, and starts the main server. It should be called before using any other PicoScenes functionality.

Returns

void

PicoScenesStop()

void PicoScenesStop ( )

noexcept

Stops the PicoScenes platform.

This function gracefully shuts down the PicoScenes platform and releases all associated resources.

Returns

void

PicoScenesWait()

void PicoScenesWait ( )

noexcept

Blocks the current thread until PicoScenes is stopped.

This function causes the current thread to wait until the PicoScenes platform is stopped. It is useful for keeping the application running while PicoScenes is active.

Returns

void