KNX IoT
KNX IoT Point API stack implementation
oc_session_events.h File Reference

session events More...

#include "oc_endpoint.h"
#include "port/oc_network_events_mutex.h"
#include "util/oc_process.h"

Go to the source code of this file.

Data Structures

struct  oc_session_event_cb
 Structure to manage session event handler list. More...
 

Typedefs

typedef struct oc_session_event_cb oc_session_event_cb_t
 Structure to manage session event handler list. More...
 
typedef void(* session_event_handler_t) (const oc_endpoint_t *endpoint, oc_session_state_t state)
 Callback function to pass the session event information to the Application. More...
 

Enumerations

enum  oc_session_state_t { OC_SESSION_CONNECTED , OC_SESSION_DISCONNECTED }
 session states More...
 

Functions

 OC_PROCESS_NAME (oc_session_events)
 
void oc_session_end_event (oc_endpoint_t *endpoint)
 session end event More...
 
void oc_session_events_set_event_delay (int secs)
 set delay for events More...
 
void oc_session_start_event (oc_endpoint_t *endpoint)
 session start event More...
 

Detailed Description

session events

Definition in file oc_session_events.h.

Typedef Documentation

◆ oc_session_event_cb_t

Structure to manage session event handler list.

◆ session_event_handler_t

typedef void(* session_event_handler_t) (const oc_endpoint_t *endpoint, oc_session_state_t state)

Callback function to pass the session event information to the Application.

Parameters
endpointthe endpoint info which the session event is happened.
statethe enumeration values in oc_session_state_t.

Definition at line 47 of file oc_session_events.h.

Enumeration Type Documentation

◆ oc_session_state_t

session states

Enumerator
OC_SESSION_CONNECTED 

session connected

OC_SESSION_DISCONNECTED 

session disconnected

Definition at line 35 of file oc_session_events.h.

35  {
oc_session_state_t
session states
@ OC_SESSION_DISCONNECTED
session disconnected
@ OC_SESSION_CONNECTED
session connected

Function Documentation

◆ oc_session_end_event()

void oc_session_end_event ( oc_endpoint_t endpoint)

session end event

Parameters
endpointstop event on endpoint

◆ oc_session_events_set_event_delay()

void oc_session_events_set_event_delay ( int  secs)

set delay for events

Parameters
secsdelay in seconds

◆ oc_session_start_event()

void oc_session_start_event ( oc_endpoint_t endpoint)

session start event

Parameters
endpointstart event on endpoint