common ESC items for all event types More...

#include <sip.h>

Data Fields
const char *	device_name

char	entity_tag [30]

const char *	event

void *	event_specific_data

int	sched_id

Detailed Description

common ESC items for all event types

The entity_id field serves as a means by which A specific entry may be found.

Definition at line 1715 of file sip.h.

Field Documentation

◆ device_name

const char* device_name

The name of the party who sent us the PUBLISH. This will more than likely correspond to a peer name.

This field's utility isn't really that great. It's mainly just a user-recognizable handle that can be printed in debug messages.

Definition at line 1725 of file sip.h.

◆ entity_tag

char entity_tag[30]

The entity ID used when corresponding with the EPA on the other side. As the ESC, we generate an entity ID for each received PUBLISH and store it in this structure.

Definition at line 1742 of file sip.h.

Referenced by create_new_sip_etag(), esc_cmp_fn(), esc_hash_fn(), get_esc_entry(), and transmit_response_with_sip_etag().

◆ event

const char* event

The event package for which this esc_entry exists. Most of the time this isn't really necessary since you'll have easy access to the ESC which contains this entry. However, in some circumstances, we won't have the ESC available.

Definition at line 1734 of file sip.h.

Referenced by create_esc_entry(), create_new_sip_etag(), and publish_expire().

◆ event_specific_data

void* event_specific_data

Each ESC entry will be for a specific event type. Those entries will need to carry data which is intrinsic to the ESC entry but which is specific to the event package

Definition at line 1758 of file sip.h.

◆ sched_id

int sched_id

The ID for the scheduler. We schedule destruction of a sip_esc_entry when we receive a PUBLISH. The destruction is scheduled for the duration received in the Expires header.

Definition at line 1750 of file sip.h.

Referenced by create_esc_entry(), esc_entry_destructor(), handle_sip_publish_modify(), handle_sip_publish_refresh(), handle_sip_publish_remove(), and publish_expire().

The documentation for this struct was generated from the following file:

sip.h