nl::Weave::Profil::ServiceDirectory::WeaveServiceManager

#include <src/lib/profiles/service-directory/ServiceDirectory.h>

Objek pengelola untuk direktori layanan Weave.

Ringkasan

Pengelola layanan Weave adalah antarmuka utama untuk aplikasi ke layanan direktori. Dengan demikian, alat ini menyembunyikan detail yang melekat dalam mencari entri direktori yang terkait dengan endpoint layanan, melakukan pencarian DNS pada satu atau beberapa nama host yang ditemukan di sana, mencoba terhubung, mengamankan koneksi dan sebagainya. Tindakan ini juga dapat mengelola cache informasi direktori layanan.

Konstruktor dan Destruktor
WeaveServiceManager(void)
Metode ini menginisialisasi instance WeaveServiceManager.
~WeaveServiceManager(void)
Metode ini menghancurkan instance WeaveServiceManager.

Jenis publik
@303{
  kWeave_DefaultSendTimeout = 15000
} 		enum
OnConnectBegin)(struct ServiceConnectBeginArgs &args) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnConnectBegin
void(*
Callback aplikasi yang dibuat tepat sebelum pembuatan koneksi.
OnServiceEndpointQueryBegin)(void) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryBegin
void(*
Callback aplikasi untuk menandai waktu kueri direktori layanan keluar.
OnServiceEndpointQueryEndWithTimeInfo)(uint64_t timeQueryReceiptMsec, uint32_t timeProcessMsec) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryEndWithTimeInfo
void(*
Callback aplikasi untuk mengirimkan nilai waktu dari respons direktori layanan.
RootDirectoryAccessor)(uint8_t *aDirectory, uint16_t aLength) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::RootDirectoryAccessor
Fungsi pengakses untuk info direktori utama.
StatusHandler)(void *anAppState, WEAVE_ERROR anError, StatusReport *aStatusReport) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::StatusHandler
void(*
Pengendali untuk kondisi error dan status.

Fungsi publik
SetConnectBeginCallback(OnConnectBegin aConnectBegin)
void
Tetapkan fungsi callback yang akan dipanggil segera sebelum koneksi dibuat.
cancel(uint64_t aServiceEp, void *aAppState)
void
Metode ini membatalkan permintaan koneksi.
clearCache(void)
void
Metode ini menghapus status dan cache pengelola jika status berada dalam status terminal kServiceMgrState_Resolved, yang berarti bahwa respons dari endpoint Direktori Layanan diterima.
connect(uint64_t aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aConnectionCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnectIntf)
Permintaan metode ini terhubung ke layanan Weave.
init(WeaveExchangeManager *aExchangeMgr, uint8_t *aCache, uint16_t aCacheLen, RootDirectoryAccessor aAccessor, WeaveAuthMode aDirAuthMode, OnServiceEndpointQueryBegin aServiceEndpointQueryBegin, OnServiceEndpointQueryEndWithTimeInfo aServiceEndpointQueryEndWithTimeInfo, OnConnectBegin aConnectBegin)
Metode ini menginisialisasi objek pengelola layanan.
lookup(uint64_t aServiceEp, HostPortList *outHostPortList)
Metode ini mencari informasi direktori untuk endpoint layanan.
lookup(uint64_t aServiceEp, uint8_t *aControlByte, uint8_t **aDirectoryEntry)
Metode ini mencari informasi direktori untuk endpoint layanan.
onConnectionClosed(WEAVE_ERROR aError)
void
Metode ini menangani peristiwa penutupan koneksi yang dilaporkan oleh konteks bursa Weave terkait.
onConnectionComplete(WEAVE_ERROR aError)
void
Metode ini menangani peristiwa koneksi selesai untuk transaksi kueri endpoint layanan.
onResponseReceived(uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg)
void
Metode ini menangani pesan respons apa pun dalam percakapan dengan layanan direktori.
onResponseTimeout(void)
void
Metode ini menangani peristiwa waktu tunggu, saat tidak ada respons yang diterima dari layanan direktori.
relocate(WEAVE_ERROR aError)
void
Metode ini memindahkan cache direktori layanan.
relocate(void)
void
Metode ini memindahkan cache direktori layanan.
replaceOrAddCacheEntry(uint16_t port, const char *hostName, uint8_t hostLen, uint64_t serviceEndpointId)
Tambahkan entri direktori nama host dan port id yang diganti di awal daftar direktori.
reset(WEAVE_ERROR aError)
void
Metode ini akan mereset pengelola layanan ke status awal.
reset(void)
void
Metode ini akan mereset pengelola layanan ke status awal.
unresolve(WEAVE_ERROR aError)
void
Metode ini membatalkan cache direktori layanan.
unresolve(void)
void
Metode ini membatalkan cache direktori layanan.

Class
nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::ConnectRequest

Class ini mewakili satu transaksi yang dikelola oleh pengelola layanan.

Jenis publik

@303

 @303
Properti
kWeave_DefaultSendTimeout

Jumlah milidetik respons harus diterima untuk kueri direktori sebelum waktu konteks pertukaran habis.

OnConnectBegin

void(* OnConnectBegin)(struct ServiceConnectBeginArgs &args)

Callback aplikasi yang dibuat tepat sebelum pembuatan koneksi.

Callback ini dapat digunakan oleh aplikasi untuk mengamati dan secara opsional mengubah argumen yang diteruskan ke #WeaveConnection::Connect() selama koneksi layanan dibuat. Callback ini akan dipanggil untuk koneksi ke endpoint layanan target, serta koneksi ke endpoint Direktori Layanan jika pencarian direktori harus dilakukan.

OnServiceEndpointQueryBegin

void(* OnServiceEndpointQueryBegin)(void)

Callback aplikasi untuk menandai waktu kueri direktori layanan keluar.

Metode ini dipanggil saat kita akan mengirim permintaan kueri endpoint layanan. Ini digunakan untuk mencocokkan dengan OnServiceEndpointQueryEnd untuk mengompensasi waktu penerbangan pesan.

OnServiceEndpointQueryEndWithTimeInfo

void(* OnServiceEndpointQueryEndWithTimeInfo)(uint64_t timeQueryReceiptMsec, uint32_t timeProcessMsec)

Callback aplikasi untuk mengirimkan nilai waktu dari respons direktori layanan.

Metode ini dipanggil saat kita mendapatkan informasi waktu dari respons kueri direktori layanan. Perhatikan bahwa callback ini hanya akan terjadi jika respons berhasil diurai dan informasi waktu disertakan

Detail
Parameter
[in] timeQueryReceiptMsec
Jumlah mdtk sejak epoch POSIX, saat kueri diterima di sisi server.
[in] timeProcessMsec
Jumlah mdtk yang dihabiskan untuk memproses kueri ini.

RootDirectoryAccessor

WEAVE_ERROR(* RootDirectoryAccessor)(uint8_t *aDirectory, uint16_t aLength)

Fungsi pengakses untuk info direktori utama.

Anda harus memulai dari mana saja dan dengan direktori layanan, Anda harus memulai dengan direktori stub yang berisi alamat server yang dapat dicapai untuk mengakses semuanya. Karena disposisi dan asal informasi ini cenderung berbeda di setiap perangkat, kami menyediakan callback pengakses di sini.

Detail
Parameter
[out] aDirectory
Pointer ke buffer untuk menulis informasi direktori.
[in] aLength
Panjang buffer yang diberikan dalam byte.
Menampilkan
WEAVE_NO_ERROR jika berhasil, jika tidak, proses pemuatan akan dibatalkan.

Pengendali Status

void(* StatusHandler)(void *anAppState, WEAVE_ERROR anError, StatusReport *aStatusReport)

Pengendali untuk kondisi error dan status.

Pengguna pengelola layanan mungkin akan diberi tahu tentang masalah dalam mencoba menjalankan permintaan koneksi dengan salah satu dari dua cara berikut. Aplikasi dapat menerima laporan status dari layanan atau menerima WEAVE_ERROR secara internal. Dalam kedua kasus tersebut, informasi akan diberikan melalui callback ini.

Detail
Parameter
[in] anAppState
Pointer ke objek aplikasi yang diteruskan ke panggilan conect() yang sesuai.
[in] anError
Kode error Weave yang menunjukkan error terjadi dalam proses mencoba menjalankan permintaan koneksi. Error ini akan berupa WEAVE_NO_ERROR jika tidak ada error yang muncul dan laporan status tersedia.
[in] aStatusReport
Pointer ke laporan status yang dihasilkan oleh layanan direktori jarak jauh. Argumen ini akan menjadi NULL jika tidak ada laporan status dan error internal diteruskan dalam argumen sebelumnya.

Fungsi publik

SetConnectBeginCallback

void SetConnectBeginCallback(
  OnConnectBegin aConnectBegin
)

Tetapkan fungsi callback yang akan dipanggil segera sebelum koneksi dibuat.

Detail
Parameter
[in] aConnectBegin
Pointer ke fungsi callback. Nilai NULL menonaktifkan callback.

WeaveServiceManager

 WeaveServiceManager(
  void
)

Metode ini menginisialisasi instance WeaveServiceManager.

Perhatikan bahwa init() harus dipanggil untuk menginisialisasi instance ini lebih lanjut.

batal

void cancel(
  uint64_t aServiceEp,
  void *aAppState
)

Metode ini membatalkan permintaan koneksi.

Metode ini membatalkan permintaan koneksi dengan mempertimbangkan ID endpoint layanan dan objek status aplikasi yang diteruskan pada waktu permintaan sebagai ID. Jika ini adalah permintaan koneksi terakhir, metode ini juga akan menghapus status koneksi direktori layanan yang tertunda.

Detail
Parameter
[in] aServiceEp
ID endpoint layanan permintaan yang dibatalkan.
[in] anAppState
Pointer ke objek status aplikasi yang diberikan ke panggilan connect().

clearCache

void clearCache(
  void
)

Metode ini menghapus status dan cache pengelola jika status berada dalam status terminal kServiceMgrState_Resolved, yang berarti bahwa respons dari endpoint Direktori Layanan diterima.

hubungkan

WEAVE_ERROR connect(
  uint64_t aServiceEp,
  WeaveAuthMode aAuthMode,
  void *aAppState,
  StatusHandler aStatusHandler,
  WeaveConnection::ConnectionCompleteFunct aConnectionCompleteHandler,
  const uint32_t aConnectTimeoutMsecs,
  const InterfaceId aConnectIntf
)

Permintaan metode ini terhubung ke layanan Weave.

Ini adalah panggilan sambungan tingkat atas. Ini pada dasarnya menghasilkan koneksi aman ke layanan Weave dengan endpoint layanan dan mode autentikasi atau mencoba mati.

Metode ini hanya dapat dipanggil setelah panggilan ke init() berhasil, dan permintaan koneksi dapat dibatalkan secara potensial oleh cancel().

Metode ini dapat dipanggil sebelum cache lokal diisi dengan data dari data default yang disediakan atau perjalanan ke layanan direktori. Pengelola layanan hanya akan mengantrekan permintaan sebelum konten cache dapat ditentukan.

Detail
Parameter
[in] aServiceEp
ID endpoint layanan, seperti yang ditentukan dalam ServiceDirectory.h, untuk layanan yang diinginkan.
[in] aAuthMode
Mode autentikasi yang akan digunakan saat terhubung ke layanan yang diminati.
[in] aAppState
Pointer ke objek status aplikasi, yang diteruskan ke callback sebagai argumen.
[in] aStatusHandler
Callback untuk dipanggil jika terjadi error sebelum koneksi selesai.
[in] aConnectionCompleteHandler
Callback untuk dipanggil jika koneksi yang diminta selesai. Perhatikan bahwa koneksi mungkin gagal dengan kode error Weave.
[in] aConnectTimeoutMsecs
Waktu tunggu koneksi TCP opsional dalam milidetik.
[in] aConnectIntf
Antarmuka opsional tempat koneksi akan dibuat.
Menampilkan
WEAVE_NO_ERROR jika berhasil; jika tidak, kode error yang terkait.

init

WEAVE_ERROR init(
  WeaveExchangeManager *aExchangeMgr,
  uint8_t *aCache,
  uint16_t aCacheLen,
  RootDirectoryAccessor aAccessor,
  WeaveAuthMode aDirAuthMode,
  OnServiceEndpointQueryBegin aServiceEndpointQueryBegin,
  OnServiceEndpointQueryEndWithTimeInfo aServiceEndpointQueryEndWithTimeInfo,
  OnConnectBegin aConnectBegin
)

Metode ini menginisialisasi objek pengelola layanan.

Agar dapat digunakan, objek pengelola layanan harus diinisialisasi. Setelah panggilan ke metode ini berhasil, klien dapat mulai memanggil connect(), lookup(), dan metode lain.

Detail
Parameter
[in] aExchangeMgr
Pointer ke bursa manager yang akan digunakan untuk semua pertukaran profil direktori layanan.
[in] aCache
Pointer ke buffer yang dapat digunakan untuk meng-cache informasi direktori.
[in] aCacheLen
Panjang cache dalam byte.
[in] aAccessor
Callback, seperti yang ditentukan dalam ServiceDirectory.h untuk dipanggil untuk memuat direktori utama sebagai titik awal untuk pencarian direktori.
[in] aDirAuthMode
Mode autentikasi yang akan digunakan saat berbicara dengan layanan direktori.
[in] aServiceEndpointQueryBegin
Pointer fungsi jenis OnServiceEndpointQueryBegin, yang dipanggil di awal permintaan direktori layanan dan memungkinkan kode aplikasi menandai waktu jika ingin menggunakan sinkronisasi waktu yang ditawarkan oleh protokol direktori layanan.
[in] aServiceEndpointQueryEndWithTimeInfo
Pointer fungsi jenis OnServiceEndpointQueryEndWithTimeInfo, yang dipanggil saat menerima direktori layanan yang memungkinkan aplikasi disinkronkan dengan layanan Weave menggunakan kolom waktu yang diberikan dalam respons. Callback ini akan dibuat setelah pengelola layanan menerima respons dengan informasi waktu. Cache seharusnya sudah berhasil diisi sebelum callback dibuat.
[in] aConnectBegin
Pointer fungsi dengan jenis OnConnectBegin, yang dipanggil tepat sebelum pembuatan koneksi dan memungkinkan aplikasi untuk mengamati dan secara opsional mengubah argumen yang diteruskan ke #WeaveConnection::Connect(). Nilai NULL (default) akan menonaktifkan callback.
Menampilkan
WEAVE_ERROR_INVALID_ytc jika argumen fungsi tidak valid; jika tidak, WEAVE_NO_ERROR.

pencarian

WEAVE_ERROR lookup(
  uint64_t aServiceEp,
  HostPortList *outHostPortList
)

Metode ini mencari informasi direktori untuk endpoint layanan.

Jika direktori layanan telah diselesaikan, yaitu jika ada operasi connect() yang berhasil, metode ini akan mengisi objek HostPortList yang disediakan.

Catatan: HostPortList terikat ke objek WeaveServiceManager; objek tersebut akan tetap valid hingga cache direktori layanan dihapus atau hingga pencarian direktori layanan lainnya terjadi.

Detail
Parameter
[in] aServiceEp
ID endpoint layanan untuk mencari.
[out] outHostPortList
Pointer ke HostPortList yang akan diisi pada pencarian entri direktori yang berhasil. Tidak boleh berupa NULL.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
jika berhasil; jika tidak, kode error masing-masing.
WEAVE_ERROR_INVALID_SERVICE_EP
jika endpoint layanan tertentu tidak ditemukan.
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
jika direktori berisi jenis entri direktori yang tidak dikenal.

pencarian

WEAVE_ERROR lookup(
  uint64_t aServiceEp,
  uint8_t *aControlByte,
  uint8_t **aDirectoryEntry
)

Metode ini mencari informasi direktori untuk endpoint layanan.

Jika direktori layanan telah diselesaikan, yaitu jika ada operasi connect() yang berhasil, metode ini akan menampilkan entri direktori berdasarkan ID endpoint layanan.

Metode ini mengekspos detail implementasi internal direktori layanan. Implementasi harus memilih menggunakan varian metode ini yang menghasilkan HostPortList.

Detail
Parameter
[in] aServiceEp
ID endpoint layanan untuk mencari.
[out] aControlByte
Pointer ke tempat untuk menulis byte kontrol entri direktori.
[out] aDirectoryEntry
Pointer pointer yang akan diarahkan ke entri direktori.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
jika berhasil; jika tidak, kode error masing-masing.
WEAVE_ERROR_INVALID_SERVICE_EP
jika endpoint layanan tertentu tidak ditemukan.
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
jika direktori berisi jenis entri direktori yang tidak dikenal.

onConnectionClosed

void onConnectionClosed(
  WEAVE_ERROR aError
)

Metode ini menangani peristiwa penutupan koneksi yang dilaporkan oleh konteks bursa Weave terkait.

Detail
Parameter
[in] aError
Error Weave yang menunjukkan alasan koneksi ini ditutup.

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

Metode ini menangani peristiwa koneksi selesai untuk transaksi kueri endpoint layanan.

Ada beberapa kemungkinan. Pertama, sambungan mungkin gagal, dalam hal ini kita sudah selesai. Jika tidak, koneksi akan selesai dan yang ingin kita lakukan adalah membuka konteks pertukaran dan mengirimkan kueri direktori.

Detail
Parameter
[in] aError
Error Weave jika ada error selama penyiapan koneksi.

onResponseReceived

void onResponseReceived(
  uint32_t aProfileId,
  uint8_t aMsgType,
  PacketBuffer *aMsg
)

Metode ini menangani pesan respons apa pun dalam percakapan dengan layanan direktori.

Detail
Parameter
[in] aProfileId
ID profil untuk pesan masuk ini.
[in] aMsgType
Jenis khusus profil untuk pesan ini.
[in] aMsg
Isi pesan ini.

onResponseTimeout

void onResponseTimeout(
  void
)

Metode ini menangani peristiwa waktu tunggu, saat tidak ada respons yang diterima dari layanan direktori.

pindah

void relocate(
  WEAVE_ERROR aError
)

Metode ini memindahkan cache direktori layanan.

Saat endpoint layanan menampilkan laporan status dengan kode status kStatus_Relokasi, aplikasi dapat memanggil unresolve() untuk mengosongkan cache dan membatalkan permintaan koneksi. Metode ini menyederhanakan penanganan error dengan memanggil unresolve() di pertama kalinya, dan reset() jika masalahnya belum teratasi.

Versi metode ini - di sini untuk kompatibilitas mundur - mengambil dan mencatat error ke dalam log, lalu memanggil relokasi(void).

Detail
Parameter
[in] aError
kesalahan untuk dicatat.
Lihat juga:
pindahkan(void)

pindah

void relocate(
  void
)

Metode ini memindahkan cache direktori layanan.

Saat endpoint layanan menampilkan laporan status dengan kode status kStatus_Relokasi, aplikasi dapat memanggil unresolve() untuk mengosongkan cache dan membatalkan permintaan koneksi. Metode ini menyederhanakan penanganan error dengan memanggil unresolve() di pertama kalinya, dan reset() jika masalahnya belum teratasi.

Lihat juga:
pindahkan(WEAVE_ERROR)

replaceOrAddCacheEntry

WEAVE_ERROR replaceOrAddCacheEntry(
  uint16_t port,
  const char *hostName,
  uint8_t hostLen,
  uint64_t serviceEndpointId
)

Tambahkan entri direktori nama host dan port id yang diganti di awal daftar direktori.

reset

void reset(
  WEAVE_ERROR aError
)

Metode ini akan mereset pengelola layanan ke status awal.

Metode ini mereset semua status pengelola layanan termasuk status komunikasi, status cache, dan status permintaan koneksi yang tertunda.

Versi metode ini - di sini untuk kompatibilitas mundur - mengambil dan mencatat error ke dalam log, lalu memanggil reset(void) .

Detail
Parameter
[in] aError
Error yang memicu operasi ini.
Lihat juga:
reset(void)

reset

void reset(
  void
)

Metode ini akan mereset pengelola layanan ke status awal.

Metode ini mereset semua status pengelola layanan termasuk status komunikasi, status cache, dan status permintaan koneksi yang tertunda.

Lihat juga:
reset(WEAVE_ERROR)

batalkan penyelesaian

void unresolve(
  WEAVE_ERROR aError
)

Metode ini membatalkan cache direktori layanan.

Metode ini menetapkan status cache direktori layanan sehingga pada permintaan berikutnya, pengelola layanan akan mengeluarkan kueri direktori layanan.

Versi metode ini - di sini untuk kompatibilitas mundur - mengambil dan mencatat error ke dalam log, lalu memanggil unresolve(void) .

Detail
Parameter
[in] aError
Error yang memicu operasi ini.
Lihat juga:
unresolve(void)

batalkan penyelesaian

void unresolve(
  void
)

Metode ini membatalkan cache direktori layanan.

Metode ini menetapkan status cache direktori layanan sehingga pada permintaan berikutnya, pengelola layanan akan mengeluarkan kueri direktori layanan.

Lihat juga:
unresolve(WEAVE_ERROR)

~PengelolaLayanan Weave

 ~WeaveServiceManager(
  void
)

Metode ini menghancurkan instance WeaveServiceManager.