nl::Inet::TunEndPoint

#include <src/inet/TunEndPoint.h>

Objek dari class ini mewakili antarmuka tunnel.

Ringkasan

Nest Inet Layer mengenkapsulasi metode untuk berinteraksi pada sistem POSIX dan sistem LwIP dengan mekanisme tunneling IP-in-IP untuk mendukung agen tunnel Weave.

Inheritance

Mewarisi dari: nl::Inet::EndPointBasis

Jenis publik

@11 enum
Status dinamis dasar tunnel yang mendasarinya.
OnPacketReceivedFunct)(TunEndPoint *endPoint, Weave::System::PacketBuffer *message) typedef
void(*
Jenis pengendali peristiwa penerimaan paket.
OnReceiveErrorFunct)(TunEndPoint *endPoint, INET_ERROR err) typedef
void(*
Jenis pengendali peristiwa error.
RouteOp{
  kRouteTunIntf_Add = 0,
  kRouteTunIntf_Del = 1
}
enum
Operasi saat menyetel antarmuka rute ke tunnel.
RouteOp typedef
Operasi saat menyetel antarmuka rute ke tunnel.

Atribut publik

OnPacketReceived
Paket endpoint menerima delegasi pengendali peristiwa.
OnReceiveError
mAppState
void *
Pointer ke objek status khusus aplikasi.
mState
enum nl::Inet::TunEndPoint::@11
Status dinamis dasar tunnel yang mendasarinya.

Fungsi publik

Free(void)
void
Tutup tunnel dan lepaskan tuas pada objek.
GetTunnelInterfaceId(void)
InterfaceId
Mendapatkan ID antarmuka tunnel.
Init(InetLayer *inetLayer)
void
Lakukan inisialisasi objek Tunnel EndPoint.
InterfaceDown(void)
Menonaktifkan antarmuka tunnel.
InterfaceUp(void)
Aktifkan antarmuka tunnel.
IsInterfaceUp(void) const
bool
Ekstrak status aktivasi antarmuka tunnel.
Open(void)
Buka antarmuka pseudo tunnel dan buat handle pada antarmuka tersebut.
Open(const char *intfName)
Send(Weave::System::PacketBuffer *message)
Mengirim paket IPv6 ke perangkat tun untuk dikirim.

Jenis publik

@11

 @11

Status dinamis dasar tunnel yang mendasarinya.

Objek diinisialisasi dalam status "terbuka", lanjutkan ke status "tertutup" jika sudah siap untuk didaur ulang.

OnPacketReceivedFunct

void(* OnPacketReceivedFunct)(TunEndPoint *endPoint, Weave::System::PacketBuffer *message)

Jenis pengendali peristiwa penerimaan paket.

Tipe pendelegasian ke lapisan yang lebih tinggi untuk bertindak setelah menerima paket IPv6 dari tunnel.

Detail
Parameter
[in] endPoint
Pointer ke objek TunEndPoint.
[in] message
Pointer ke objek pesan Weave::System::PacketBuffer.

OnReceiveErrorFunct

void(* OnReceiveErrorFunct)(TunEndPoint *endPoint, INET_ERROR err)

Jenis pengendali peristiwa error.

Tipe delegasi ke lapisan yang lebih tinggi untuk bertindak setelah terjadi error saat memproses paket IPv6 dari tunnel.

Detail
Parameter
[in] endPoint
Objek TunEndPoint.
[in] err
Kode error dilaporkan.

RouteOp

 RouteOp

Operasi saat menyetel antarmuka rute ke tunnel.

Nilai jenis enumerasi ini digunakan saat menetapkan rute untuk tunnel yang dienkapsulasi.

Properti
kRouteTunIntf_Add

Menambahkan rute untuk awalan.

kRouteTunIntf_Del

Menghapus rute untuk awalan.

RouteOp

enum nl::Inet::TunEndPoint::RouteOp RouteOp

Operasi saat menyetel antarmuka rute ke tunnel.

Nilai jenis enumerasi ini digunakan saat menetapkan rute untuk tunnel yang dienkapsulasi.

Atribut publik

OnPacketReceived

OnPacketReceivedFunct OnPacketReceived

Paket endpoint menerima delegasi pengendali peristiwa.

OnReceiveError

OnReceiveErrorFunct OnReceiveError

mAppState

void * mAppState

Pointer ke objek status khusus aplikasi.

mState

enum nl::Inet::TunEndPoint::@11 mState

Status dinamis dasar tunnel yang mendasarinya.

Objek diinisialisasi dalam status "terbuka", lanjutkan ke status "tertutup" jika sudah siap untuk didaur ulang.

Fungsi publik

Gratis

void Free(
  void
)

Tutup tunnel dan lepaskan tuas pada objek.

Tutup perangkat antarmuka pseudo tunnel dan mengurangi jumlah referensi objek InetLayer.

GetTunnelInterfaceId

InterfaceId GetTunnelInterfaceId(
  void
)

Mendapatkan ID antarmuka tunnel.

Detail
Hasil
ID antarmuka tunnel.

Inisiasi

void Init(
  InetLayer *inetLayer
)

Lakukan inisialisasi objek Tunnel EndPoint.

Detail
Parameter
[in] inetLayer
Pointer ke objek lapisan Inet yang membuat Tunnel EndPoint.

InterfaceDown

INET_ERROR InterfaceDown(
  void
)

Menonaktifkan antarmuka tunnel.

Detail
Nilai Pengembalian
INET_NO_ERROR
berhasil: antarmuka tunnel dinonaktifkan.
other
error sistem atau platform lain

InterfaceUp

INET_ERROR InterfaceUp(
  void
)

Aktifkan antarmuka tunnel.

Detail
Nilai Pengembalian
INET_NO_ERROR
berhasil: antarmuka tunnel diaktifkan.
other
error sistem atau platform lain

IsInterfaceUp

bool IsInterfaceUp(
  void
) const 

Ekstrak status aktivasi antarmuka tunnel.

Detail
Hasil
true jika antarmuka tunnel aktif. Jika tidak aktif, false.

Terbuka

INET_ERROR Open(
  void
)

Buka antarmuka pseudo tunnel dan buat handle pada antarmuka tersebut.

Detail
Hasil
INET_NO_ERROR saat berhasil, atau error OS yang dipetakan INET terkait.

Terbuka

INET_ERROR Open(
  const char *intfName
)

Kirim

INET_ERROR Send(
  Weave::System::PacketBuffer *message
)

Mengirim paket IPv6 ke perangkat tun untuk dikirim.

Detail
Parameter
[in] message
paket IPv6 untuk dikirim.
Nilai Pengembalian
INET_NO_ERROR
berhasil: paket dienkapsulasi dan diantrekan untuk dikirim
INET_ERROR_NOT_SUPPORTED
paket bukan IP versi 6
INET_ERROR_BAD_ARGS
message mencetak NULL poin