nl::Weave::Warm::Platform

Ringkasan

Fungsi
AddRemoveHostAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, uint8_t inPrefixLength, bool inAdd)
API platform yang akan dipanggil Warm untuk menambahkan / menghapus alamat IP host ke antarmuka yang ditentukan pada stack Host TCP/IP.
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
API platform yang akan dipanggil Warm untuk menambahkan / menghapus rute IP untuk antarmuka yang ditentukan pada stack TCP/IP host.
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
API platform yang akan dipanggil Warm untuk menambahkan / menghapus alamat IP ke antarmuka yang ditentukan pada stack TCP/IP Thread.
AddRemoveThreadRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
API platform yang akan dipanggil Warm untuk menambahkan / menghapus rute IP untuk antarmuka yang ditentukan pada stack TCP/IP Thread.
CriticalSectionEnter(void)
void
API platform yang akan dipanggil Warm untuk melindungi akses ke State internal.
CriticalSectionExit(void)
void
API platform yang akan dipanggil Warm untuk merilis akses terlindungi ke State internal.
Init(WarmFabricStateDelegate *inFabricStateDelegate)
API platform yang akan dipanggil oleh Warm sebagai bagian dari eksekusi nl::Warm::Init.
RequestInvokeActions(void)
void
API platform yang akan dipanggil Warm untuk mengumumkan bahwa platform harus memanggil InvokeActions.
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
API platform yang akan dipanggil Warm untuk mengubah prioritas rute IP yang ada untuk antarmuka yang ditentukan pada stack TCP/IP Thread.
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
API platform yang akan dipanggil Warm untuk memulai / menghentikan iklan awalan IP di antarmuka Thread.

Fungsi

AddRemoveHostAddress

PlatformResult AddRemoveHostAddress(
  InterfaceType inInterfaceType,
  const Inet::IPAddress & inAddress,
  uint8_t inPrefixLength,
  bool inAdd
)

API platform yang akan dipanggil Warm untuk menambahkan / menghapus alamat IP host ke antarmuka yang ditentukan pada stack Host TCP/IP.

Setelah selesai, platform harus memanggil ReportActionComplete dengan hasil akhir.

Detail
Parameter
[in] inInterfaceType
Antarmuka yang akan diubah.
[in] inAddress
Alamat IP yang akan ditambahkan/dihapus.
[in] inPrefixLength
Panjang awalan inAddress.
[in] inAdd
benar untuk menambahkan alamat, salah untuk menghapus alamat.
Nilai Pengembalian
kPlatformResultSuccess
Operasi berhasil diselesaikan.
kPlatformResultFailure
Operasi gagal.
kPlatformResultInProgress
Operasi akan selesai secara asinkron.

AddRemoveHostRoute

PlatformResult AddRemoveHostRoute(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority,
  bool inAdd
)

API platform yang akan dipanggil Warm untuk menambahkan / menghapus rute IP untuk antarmuka yang ditentukan pada stack TCP/IP host.

Setelah selesai, platform harus memanggil ReportActionComplete dengan hasil akhir.

Detail
Parameter
[in] inInterfaceType
Antarmuka yang akan diubah.
[in] inPrefix
Awalan IP yang akan ditambahkan / dihapus.
[in] inPriority
Prioritas yang akan digunakan saat rute ditetapkan.
[in] inAdd
true untuk menambahkan awalan sebagai rute, false untuk menghapus awalan sebagai rute.
Nilai Pengembalian
kPlatformResultSuccess
Operasi berhasil diselesaikan.
kPlatformResultFailure
Operasi gagal.
kPlatformResultInProgress
Operasi akan selesai secara asinkron.

AddRemoveThreadAddress

PlatformResult AddRemoveThreadAddress(
  InterfaceType inInterfaceType,
  const Inet::IPAddress & inAddress,
  bool inAdd
)

API platform yang akan dipanggil Warm untuk menambahkan / menghapus alamat IP ke antarmuka yang ditentukan pada stack TCP/IP Thread.

Setelah selesai, platform harus memanggil ReportActionComplete dengan hasil akhir.

Detail
Parameter
[in] inInterfaceType
Antarmuka yang akan diubah.
[in] inAddress
Alamat IP yang akan ditambahkan/dihapus.
[in] inAdd
benar untuk menambahkan alamat, salah untuk menghapus alamat.
Nilai Pengembalian
kPlatformResultSuccess
Operasi berhasil diselesaikan.
kPlatformResultFailure
Operasi gagal.
kPlatformResultInProgress
Operasi akan selesai secara asinkron.

AddRemoveThreadRoute

PlatformResult AddRemoveThreadRoute(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority,
  bool inAdd
)

API platform yang akan dipanggil Warm untuk menambahkan / menghapus rute IP untuk antarmuka yang ditentukan pada stack TCP/IP Thread.

Setelah selesai, platform harus memanggil ReportActionComplete dengan hasil akhir.

Detail
Parameter
[in] inInterfaceType
Antarmuka yang akan diubah.
[in] inPrefix
Awalan IP yang akan ditetapkan / dihapus.
[in] inPriority
Prioritas yang akan digunakan saat rute ditetapkan.
[in] inAdd
true untuk menambahkan awalan sebagai rute, false untuk menghapus awalan sebagai rute.
Nilai Pengembalian
kPlatformResultSuccess
Operasi berhasil diselesaikan.
kPlatformResultFailure
Operasi gagal.
kPlatformResultInProgress
Operasi akan selesai secara asinkron.

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

API platform yang akan dipanggil Warm untuk melindungi akses ke State internal.

CriticalSectionExit

void CriticalSectionExit(
  void
)

API platform yang akan dipanggil Warm untuk merilis akses terlindungi ke State internal.

Inisiasi

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

API platform yang akan dipanggil oleh Warm sebagai bagian dari eksekusi nl::Warm::Init.

Detail
Parameter
[in] inFabricStateDelegate
Pointer ke objek fabricStateDelegate yang digunakan oleh Warm untuk menerima update status fabric.
Hasil
WEAVE_NO_ERROR jika berhasil, kode error jika tidak.

RequestInvokeActions

void RequestInvokeActions(
  void
)

API platform yang akan dipanggil Warm untuk mengumumkan bahwa platform harus memanggil InvokeActions.

SetThreadRoutePriority

PlatformResult SetThreadRoutePriority(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority
)

API platform yang akan dipanggil Warm untuk mengubah prioritas rute IP yang ada untuk antarmuka yang ditentukan pada stack TCP/IP Thread.

Setelah selesai, platform harus memanggil ReportActionComplete dengan hasil akhir.

Detail
Parameter
[in] inInterfaceType
Antarmuka yang akan diubah.
[in] inPrefix
Awalan IP yang akan diubah.
[in] inPriority
Prioritas baru yang akan diterapkan ke rute.
Nilai Pengembalian
kPlatformResultSuccess
Operasi berhasil diselesaikan.
kPlatformResultFailure
Operasi gagal.
kPlatformResultInProgress
Operasi akan selesai secara asinkron.

StartStopThreadAdvertisement

PlatformResult StartStopThreadAdvertisement(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  bool inStart
)

API platform yang akan dipanggil Warm untuk memulai / menghentikan iklan awalan IP di antarmuka Thread.

Setelah selesai, platform harus memanggil ReportActionComplete dengan hasil akhir.

Detail
Parameter
[in] inInterfaceType
Antarmuka yang akan diubah.
[in] inPrefix
Awalan IP tempat iklan harus dimulai / dihentikan.
[in] inStart
benar untuk mulai beriklan, salah untuk menghentikan iklan.
Nilai Pengembalian
kPlatformResultSuccess
Operasi berhasil diselesaikan.
kPlatformResultFailure
Operasi gagal.
kPlatformResultInProgress
Operasi akan selesai secara asinkron.