nl::Weave::HostPortList

#include <src/lib/core/HostPortList.h>

Để quản lý và điều chỉnh Danh sách cổng lưu trữ, một tập hợp nhỏ gọn, được mã hoá nhị phân gồm các bộ nhận dạng máy chủ và cổng được liên kết với Thư mục dịch vụ Weave.

Tóm tắt

Hàm khởi tạo và phá huỷ
HostPortList(void)
Hàm khởi tạo mặc định của lớp (vô hiệu).
HostPortList(const uint8_t *hostPortList, uint8_t hostPortCount, const uint8_t *suffixList, const uint8_t suffixCount)

Hàm công khai
Clear(void)
void
Đặt lại danh sách này thành trống.
Get(uint8_t index, char *hostBuf, uint32_t hostBufSize, uint16_t & port) const
Lấy tên máy chủ và cổng tại chỉ mục được chỉ định trong danh sách.
IsEmpty(void) const
bool
Pop(char *hostBuf, uint32_t hostBufSize, uint16_t & port)
Lấy và xoá tên máy chủ cũng như cổng đầu tiên khỏi danh sách.

Hàm công khai

Xóa

void Clear(
  void
)

Đặt lại danh sách này thành trống.

Get

WEAVE_ERROR Get(
  uint8_t index,
  char *hostBuf,
  uint32_t hostBufSize,
  uint16_t & port
) const

Lấy tên máy chủ và cổng tại chỉ mục được chỉ định trong danh sách.

Chi tiết
Tham số
[in] index
Vị trí trong danh sách để trả về tên máy chủ và cổng.
[in,out] hostBuf
Con trỏ đến bộ nhớ để sao chép tên máy chủ lưu trữ.
[in] hostBufSize
Dung lượng lưu trữ còn trống trong hostBuf.
[out] port
Số cổng.
Giá trị trả về
WEAVE_ERROR_INVALID_ARGUMENT
Chỉ mục được yêu cầu vượt quá kích thước của danh sách.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
Phần tử Cổng máy chủ được yêu cầu là loại không được hỗ trợ.
WEAVE_ERROR_BUFFER_TOO_SMALL
Độ dài tên máy chủ lưu trữ của Cổng máy chủ dài hơn vùng đệm được cung cấp.
WEAVE_NO_ERROR
Khi thành công.

HostPortList

 HostPortList(
  void
)

Hàm khởi tạo mặc định của lớp (vô hiệu).

HostPortList

 HostPortList(
  const uint8_t *hostPortList,
  uint8_t hostPortCount,
  const uint8_t *suffixList,
  const uint8_t suffixCount
)

IsEmpty

bool IsEmpty(
  void
) const

Nhạc Pop

WEAVE_ERROR Pop(
  char *hostBuf,
  uint32_t hostBufSize,
  uint16_t & port
)

Lấy và xoá tên máy chủ cũng như cổng đầu tiên khỏi danh sách.

Chi tiết
Tham số
[in,out] hostBuf
Con trỏ đến bộ nhớ để sao chép tên máy chủ lưu trữ.
[in] hostBufSize
Dung lượng lưu trữ còn trống trong hostBuf.
[out] port
Số cổng.
Giá trị trả về
WEAVE_ERROR_HOST_PORT_LIST_EMPTY
Không có mục nào trong danh sách này.
WEAVE_ERROR_UNSUPPORTED_HOST_PORT_ELEMENT
Phần tử Cổng máy chủ gặp phải là loại không được hỗ trợ.
WEAVE_ERROR_BUFFER_TOO_SMALL
Độ dài tên máy chủ lưu trữ của Cổng máy chủ dài hơn vùng đệm được cung cấp.
WEAVE_NO_ERROR
Khi thành công.