supervisor.h File Reference

File containing the definition of the supervisor service. More...

#include "supervisor_config.h"

Include dependency graph for supervisor.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
struct mac_conn_info	get_mac_conn_cmd (uint8_t mac_addr[], void *mac_conn_arg)
	Return a mac_conn_info for a given MAC address. More...
void	ap_service_callback (struct supervisor_context *context, uint8_t mac_addr[], enum AP_CONNECTION_STATUS status)
	The AP service callback. More...
int	run_supervisor (char *server_path, unsigned int port, struct supervisor_context *context)
	Executes the supervisor service. More...
void	close_supervisor (struct supervisor_context *context)
	Closes the supervisor service. More...

Detailed Description

File containing the definition of the supervisor service.

Author

Alexandru Mereacre

Date

2020

Copyright

SPDX-FileCopyrightText: © 2020 NQMCyber Ltd and edgesec contributors SPDX-License-Identifier: LGPL-3.0-or-later

Function Documentation

ap_service_callback()

void ap_service_callback	(	struct supervisor_context *	context,
		uint8_t	mac_addr[],
		enum AP_CONNECTION_STATUS	status
	)

The AP service callback.

Parameters

context	The supervisor context
mac_addr	The STA mac address
status	The STA connection status

Returns

0 on success, -1 on failure

close_supervisor()

void close_supervisor

(

struct supervisor_context *

context

)

Closes the supervisor service.

Parameters

context

The supervisor structure

Returns

true on success, false otherwise

get_mac_conn_cmd()

struct mac_conn_info get_mac_conn_cmd	(	uint8_t	mac_addr[],
		void *	mac_conn_arg
	)

Return a mac_conn_info for a given MAC address.

Parameters

mac_addr	The input MAC adderss
mac_conn_arg	The supervisor_context pointer

Returns

struct mac_conn_info

run_supervisor()

int run_supervisor	(	char *	server_path,
		unsigned int	port,
		struct supervisor_context *	context
	)

Executes the supervisor service.

Parameters

server_path	The domain socket path
port	The UDP port
context	The supervisor structure

Returns

int The domain socket