nl::Weave::System

Ringkasan

Enumerasi
@18{
  kTimerFactor_micro_per_milli = 1000,
  kTimerFactor_milli_per_unit = 1000,
  kTimerFactor_nano_per_milli = 1000000,
  kTimerFactor_micro_per_unit = 1000000
} 		enum
@19{
  kEvent_ReleaseObj = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(0),
  kEvent_ScheduleWork = _WEAVE_SYSTEM_CONFIG_LWIP_EVENT(1)
} 		enum
Definisi jenis peristiwa lapisan Inet.
LayerState{
  kLayerState_NotInitialized = 0,
  kLayerState_Initialized = 1
} 		enum
Status objek Layer.

Typedef
Event nl::Weave::System::Event
Objek dasar untuk semua peristiwa InetLayer.
EventType nl::Weave::System::EventType
Jenis dasar untuk semua peristiwa InetLayer.
LwIPEventHandlerFunction)(Object &aTarget, EventType aEventType, uintptr_t aArgument) typedef
Error(*

Fungsi
DescribeErrorLwIP(Error aError)
NL_DLL_EXPORT const char *
Ini mengimplementasikan fungsi untuk mengembalikan string C deskriptif khusus LwIP yang dihentikan NULL, yang terkait dengan error LwIP yang dipetakan dan ditentukan.
DescribeErrorPOSIX(Error aError)
NL_DLL_EXPORT const char *
Tindakan ini mengimplementasikan fungsi untuk menampilkan string C deskriptif khusus OS yang dihentikan NULL, yang terkait dengan error OS yang dipetakan dan ditentukan.
FormatLwIPError(char *buf, uint16_t bufSize, int32_t err)
bool
Mengingat error LwIP, menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia dan menjelaskan error tersebut.
FormatPOSIXError(char *buf, uint16_t bufSize, int32_t err)
bool
Mengingat error POSIX, menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia dan menjelaskan error tersebut.
FormatSystemLayerError(char *buf, uint16_t bufSize, int32_t err)
bool
Mengingat error Layer Sistem, menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia dan menjelaskan error tersebut.
IsErrorLwIP(Error aError)
NL_DLL_EXPORT bool
Tindakan ini akan menerapkan fungsi introspeksi untuk error Layer Sistem Weave yang memungkinkan pemanggil menentukan apakah error yang ditentukan merupakan error LwIP internal yang mendasarinya.
IsErrorPOSIX(Error aError)
NL_DLL_EXPORT bool
Tindakan ini akan menerapkan fungsi introspeksi untuk error Layer Sistem Weave yang memungkinkan pemanggil menentukan apakah error yang ditentukan adalah error OS internal yang mendasarinya.
IsEventOfType(EventType aType)
bool
Periksa untuk memverifikasi apakah EventType adalah valid.
MapErrorLwIP(err_t aError)
NL_DLL_EXPORT Error
Tindakan ini akan menerapkan fungsi pemetaan untuk error Layer Sistem Weave System yang memungkinkan pemetaan error stack jaringan LwIP dasar ke dalam rentang khusus platform atau sistem.
MapErrorPOSIX(int aError)
NL_DLL_EXPORT Error
Tindakan ini akan menerapkan fungsi pemetaan untuk error Layer Sistem Weave yang memungkinkan pemetaan bilangan bulat di ruang angka jaringan POSIX dasar dan error stack OS ke dalam rentang khusus platform atau sistem.
RegisterLwIPErrorFormatter(void)
void
Mendaftarkan pemformat error teks untuk error LwIP.
RegisterPOSIXErrorFormatter(void)
void
Daftarkan pemformat error teks untuk error POSIX.
RegisterSystemLayerErrorFormatter(void)
void
Daftarkan pemformat error teks untuk error Layer Sistem.

Class
nl::Weave::System::Layer 

This provides access to timers according to the configured event handling model.

nl::Weave::System::LwIPEventHandlerDelegate
nl::Weave::System::Mutex 

This class represents a simple mutual exclusion lock used on platforms with preemptively scheduled multi-threaded
programming environments, for example, POSIX threads and FreeRTOS.

nl::Weave::System::Object

Ini mewakili objek yang dihitung dengan referensi yang dialokasikan dari ruang yang terdapat dalam ObjectPool<t, n=""> . &lt;/t,&gt;
nl::Weave::System::PacketBuffer

Class buffer paket adalah struktur inti yang digunakan untuk memanipulasi paket data yang diserialisasi octet, biasanya dalam konteks jaringan komunikasi data, seperti Bluetooth atau protokol Internet.

nl::Weave::System::Timer

Ini adalah class internal untuk Lapisan Sistem Weave, yang digunakan untuk menampilkan timer satu kali yang sedang berlangsung.

Struct
nl::Weave::System::LwIPEvent

Serikat
nl::Weave::System::ObjectArena 

A union template used for representing a well-aligned block of memory.

Namespace
nl::Weave::System::Platform
nl::Weave::System::Stats

Enumerasi

@18 tahun

 @18
Properti
kTimerFactor_micro_per_milli

Jumlah nanodetik dalam mikrodetik.

kTimerFactor_micro_per_unit

Jumlah nanodetik dalam milidetik.

kTimerFactor_milli_per_unit

Jumlah mikrodetik dalam milidetik.

kTimerFactor_nano_per_milli

Jumlah milidetik dalam per detik.

@19 tahun

 @19

Definisi jenis peristiwa lapisan Inet.

Properti
kEvent_ReleaseObj

Peristiwa penghentian objek SystemLayer.

kEvent_ScheduleWork

Peristiwa untuk penjadwalan pekerjaan di thread Layer Sistem.

LayerState

 LayerState

Status objek Layer.

Properti
kLayerState_Initialized

Status diinisialisasi.

kLayerState_NotInitialized

Bukan status diinisialisasi.

Typedef

Acara

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_OBJECT_TYPE Event

Objek dasar untuk semua peristiwa InetLayer.

Ini ditentukan ke jenis khusus platform atau sistem.

EventType

WEAVE_SYSTEM_CONFIG_LWIP_EVENT_TYPE EventType

Jenis dasar untuk semua peristiwa InetLayer.

Ini ditentukan ke jenis khusus platform atau sistem.

LwIPEventHandlerFunction

Error(* LwIPEventHandlerFunction)(Object &aTarget, EventType aEventType, uintptr_t aArgument)

Fungsi

DescribeErrorLwIP

NL_DLL_EXPORT const char * DescribeErrorLwIP(
  Error aError
)

Ini mengimplementasikan fungsi untuk mengembalikan string C deskriptif khusus LwIP yang dihentikan NULL, yang terkait dengan error LwIP yang dipetakan dan ditentukan.

Detail
Parameter
[in] err
Error khusus LwIP yang dipetakan untuk dijelaskan.
Hasil
String C deskriptif khusus LwIP yang dihentikan NULL yang menjelaskan error.

DescribeErrorPOSIX

NL_DLL_EXPORT const char * DescribeErrorPOSIX(
  Error aError
)

Ini mengimplementasikan fungsi untuk menampilkan string C deskriptif khusus OS yang dihentikan NULL, yang terkait dengan error OS yang dipetakan dan ditentukan.

Detail
Parameter
[in] err
Error khusus OS yang dipetakan untuk dijelaskan.
Hasil
String C deskriptif khusus OS yang dihentikan NULL yang menjelaskan error.

FormatLwIPError

bool FormatLwIPError(
  char *buf,
  uint16_t bufSize,
  int32_t err
)

Mengingat error LwIP, menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia dan menjelaskan error tersebut.

Detail
Parameter
[in] buf
Buffer tempat string error akan ditempatkan.
[in] bufSize
Ukuran buffer yang disediakan dalam byte.
[in] err
Error yang akan dijelaskan.
Hasil
true Jika string deskripsi ditulis ke dalam buffer yang disediakan.
Hasil
false Jika kesalahan yang diberikan bukan kesalahan LwIP.

FormatPOSIXError

bool FormatPOSIXError(
  char *buf,
  uint16_t bufSize,
  int32_t err
)

Mengingat error POSIX, menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia dan menjelaskan error tersebut.

Detail
Parameter
[in] buf
Buffer tempat string error akan ditempatkan.
[in] bufSize
Ukuran buffer yang disediakan dalam byte.
[in] err
Error yang akan dijelaskan.
Hasil
true Jika string deskripsi ditulis ke dalam buffer yang disediakan.
Hasil
false Jika error yang diberikan bukan error POSIX.

FormatSystemLayerError

bool FormatSystemLayerError(
  char *buf,
  uint16_t bufSize,
  int32_t err
)

Mengingat error Layer Sistem, menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia dan menjelaskan error tersebut.

Detail
Parameter
[in] buf
Buffer tempat string error akan ditempatkan.
[in] bufSize
Ukuran buffer yang disediakan dalam byte.
[in] err
Error yang akan dijelaskan.
Hasil
true Jika string deskripsi ditulis ke dalam buffer yang disediakan.
Hasil
false Jika error yang diberikan bukan error Lapisan Sistem.

IsErrorLwIP

NL_DLL_EXPORT bool IsErrorLwIP(
  Error aError
)

Tindakan ini akan menerapkan fungsi introspeksi untuk error Layer Sistem Weave yang memungkinkan pemanggil menentukan apakah error yang ditentukan merupakan error LwIP internal yang mendasarinya.

Detail
Parameter
[in] err
Error yang dipetakan untuk menentukan apakah error tersebut adalah error LwIP.
Hasil
True jika error yang ditentukan adalah error LwIP; jika tidak, salah (false).

IsErrorPOSIX

NL_DLL_EXPORT bool IsErrorPOSIX(
  Error aError
)

Tindakan ini akan menerapkan fungsi introspeksi untuk error Layer Sistem Weave yang memungkinkan pemanggil menentukan apakah error yang ditentukan adalah error OS internal yang mendasarinya.

Detail
Parameter
[in] err
Error yang dipetakan untuk menentukan apakah merupakan error OS.
Hasil
True jika error yang ditentukan adalah error OS; jika tidak, salah (false).

IsEventOfType

bool IsEventOfType(
  EventType aType
)

Periksa untuk memverifikasi apakah EventType adalah valid.

Detail
Parameter
[in] aEventType
Jenis peristiwa Lapisan Sistem Weave.
Hasil
benar (true) jika berada dalam rentang yang dienumerasi; jika tidak, salah (false).

MapErrorLwIP

NL_DLL_EXPORT Error MapErrorLwIP(
  err_t aError
)

Tindakan ini akan menerapkan fungsi pemetaan untuk error Layer Sistem Weave System yang memungkinkan pemetaan error stack jaringan LwIP dasar ke dalam rentang khusus platform atau sistem.

Detail
Parameter
[in] e
Error LwIP untuk pemetaan.
Hasil
Error OS atau jaringan LwIP yang dipetakan.

MapErrorPOSIX

NL_DLL_EXPORT Error MapErrorPOSIX(
  int aError
)

Tindakan ini akan menerapkan fungsi pemetaan untuk error Layer Sistem Weave yang memungkinkan pemetaan bilangan bulat di ruang angka jaringan POSIX dasar dan error stack OS ke dalam rentang khusus platform atau sistem.

Kode error di luar standar yang saat ini ditetapkan oleh POSIX atau standar ISO C/C++ dipetakan mirip dengan kode standar.

Detail
Parameter
[in] e
Error jaringan atau OS POSIX untuk dipetakan.
Hasil
Error OS atau jaringan POSIX yang dipetakan.

RegisterLwIPErrorFormatter

void RegisterLwIPErrorFormatter(
  void
)

Mendaftarkan pemformat error teks untuk error LwIP.

RegisterPOSIXErrorFormatter

void RegisterPOSIXErrorFormatter(
  void
)

Daftarkan pemformat error teks untuk error POSIX.

RegisterSystemLayerErrorFormatter

void RegisterSystemLayerErrorFormatter(
  void
)

Daftarkan pemformat error teks untuk error Layer Sistem.