oc_main.h File Reference

functions to be called from main, including device callbacks More...

#include "oc_api.h"

Go to the source code of this file.

Data Structures
struct	oc_factory_presets_t
	The factory presets info. More...
struct	oc_hostname_t
	The hostname info. More...
struct	oc_loadstate_t
	The lsm change info. More...
struct	oc_programming_mode_t
	The programming mode info. More...
struct	oc_reset_t
	The reset info. More...
struct	oc_restart_t
	The restart info. More...

Typedefs
typedef struct oc_factory_presets_t	oc_factory_presets_t
	The factory presets info. More...
typedef struct oc_hostname_t	oc_hostname_t
	The hostname info. More...
typedef struct oc_loadstate_t	oc_loadstate_t
	The lsm change info. More...
typedef struct oc_programming_mode_t	oc_programming_mode_t
	The programming mode info. More...
typedef struct oc_reset_t	oc_reset_t
	The reset info. More...
typedef struct oc_restart_t	oc_restart_t
	The restart info. More...

Functions
bool	oc_drop_command (size_t device)
	Get status of dropping of logical device. More...
oc_factory_presets_t *	oc_get_factory_presets_cb (void)
	retrieve the factory reset info, e.g. More...
oc_hostname_t *	oc_get_hostname_cb (void)
	retrieve the hostname info, e.g. More...
oc_loadstate_t *	oc_get_lsm_change_cb (void)
	retrieve the lsm change info, e.g. More...
oc_programming_mode_t *	oc_get_programming_mode_cb (void)
	retrieve the programming mode info, e.g. More...
oc_reset_t *	oc_get_reset_cb (void)
	retrieve the reset info, e.g. More...
oc_restart_t *	oc_get_restart_cb (void)
	retrieve the restart info, e.g. More...
bool	oc_main_initialized (void)
	is main initialized More...
void	oc_set_drop_commands (size_t device, bool drop)
	Set acceptance of new commands(GET/PUT/POST/DELETE) for logical device. More...

Detailed Description

functions to be called from main, including device callbacks

Definition in file oc_main.h.

Typedef Documentation

oc_factory_presets_t

typedef struct oc_factory_presets_t oc_factory_presets_t

The factory presets info.

oc_hostname_t

typedef struct oc_hostname_t oc_hostname_t

The hostname info.

oc_loadstate_t

typedef struct oc_loadstate_t oc_loadstate_t

The lsm change info.

oc_programming_mode_t

typedef struct oc_programming_mode_t oc_programming_mode_t

The programming mode info.

oc_reset_t

typedef struct oc_reset_t oc_reset_t

The reset info.

oc_restart_t

typedef struct oc_restart_t oc_restart_t

The restart info.

Function Documentation

oc_drop_command()

bool oc_drop_command

(

size_t

device

)

Get status of dropping of logical device.

Parameters

[in]

device

the index of the logical device

Returns

true if the device dropping new commands

oc_get_factory_presets_cb()

oc_factory_presets_t* oc_get_factory_presets_cb

(

void

)

retrieve the factory reset info, e.g.

the callback and callback data

Returns

oc_factory_presets_t* the preset data

oc_get_hostname_cb()

oc_hostname_t* oc_get_hostname_cb

(

void

)

retrieve the hostname info, e.g.

the callback and callback data

Returns

oc_hostname_t* the hostname info

oc_get_lsm_change_cb()

oc_loadstate_t* oc_get_lsm_change_cb

(

void

)

retrieve the lsm change info, e.g.

the callback and callback data

Returns

oc_hostname_t* the load state info

oc_get_programming_mode_cb()

oc_programming_mode_t* oc_get_programming_mode_cb

(

void

)

retrieve the programming mode info, e.g.

the callback and callback data

Returns

oc_programming_mode_t* the programming mode info

oc_get_reset_cb()

oc_reset_t* oc_get_reset_cb

(

void

)

retrieve the reset info, e.g.

the callback and callback data

Returns

oc_reset_t* the reset data

oc_get_restart_cb()

oc_restart_t* oc_get_restart_cb

(

void

)

retrieve the restart info, e.g.

the callback and callback data

Returns

oc_restart_t* the restart data

oc_main_initialized()

bool oc_main_initialized

(

void

)

is main initialized

Returns

true

false

oc_set_drop_commands()

void oc_set_drop_commands	(	size_t	device,
		bool	drop
	)

Set acceptance of new commands(GET/PUT/POST/DELETE) for logical device.

The device drops/accepts new commands when the drop is set to true/false.

Note

If OC_SECURITY is set, this call is used to drop all new incoming commands during closing TLS sessions (CLOSE_ALL_TLS_SESSIONS).

Parameters

[in]	device	index of the logical device
[in]	drop	set whether all new commands will be accepted/dropped