ndn-lite
Data Fields
ndn_face_intf Struct Reference

Abstract NDN network face. More...

#include <face.h>

Collaboration diagram for ndn_face_intf:
Collaboration graph

Data Fields

ndn_face_intf_up up
 Turn on the face. More...
 
ndn_face_intf_send send
 Send out a packet. More...
 
ndn_face_intf_down down
 Shutdown the face temporarily. More...
 
ndn_face_intf_destroy destroy
 Destructor. More...
 
ndn_table_id_t face_id
 Unique Face ID. More...
 
uint8_t state
 The state of the face. More...
 
uint8_t type
 The type of the face, reserved. More...
 

Detailed Description

Abstract NDN network face.

An abstract base class for all faces. Derived classes should implement the function ndn_face_intf::up, ndn_face_intf::send, ndn_face_intf::down, and ndn_face_intf::destroy with platform-specific APIs via assigning function pointers in ndn_face_intf.

Attention
ndn_face_intf should always be the first member of any face class.

Field Documentation

◆ destroy

ndn_face_intf_destroy ndn_face_intf::destroy

Destructor.

See also
ndn_face_destroy

◆ down

ndn_face_intf_down ndn_face_intf::down

Shutdown the face temporarily.

See also
ndn_face_down

◆ face_id

ndn_table_id_t ndn_face_intf::face_id

Unique Face ID.

◆ send

ndn_face_intf_send ndn_face_intf::send

Send out a packet.

See also
ndn_face_send

◆ state

uint8_t ndn_face_intf::state

The state of the face.

Currently not used by the forwarder. Possible values: NDN_FACE_STATE_DOWN, NDN_FACE_STATE_UP, NDN_FACE_STATE_DESTROYED.

◆ type

uint8_t ndn_face_intf::type

The type of the face, reserved.

Possible values: NDN_FACE_TYPE_APP, NDN_FACE_TYPE_NET, NDN_FACE_TYPE_UNDEFINED

◆ up

ndn_face_intf_up ndn_face_intf::up

Turn on the face.

See also
ndn_face_up

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