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

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

Lớp này biểu thị một giao dịch duy nhất do trình quản lý dịch vụ quản lý.

Tóm tắt

Các thuộc tính công khai

mAppState
void *
mAuthMode
WeaveAuthMode
mConnIntf
InterfaceId
giao diện mà qua đó kết nối sẽ được thiết lập.
mConnectTimeoutMsecs
uint32_t
thời gian chờ để lệnh gọi Connect thành công hoặc trả về lỗi.
mConnection
Một kết nối để lưu trữ tại đây trong khi chờ hoàn tất.
mConnectionCompleteHandler
Con trỏ trỏ đến một hàm sẽ được gọi khi hoàn tất kết nối đến điểm cuối của dịch vụ đích.
mServiceEp
uint64_t
mStatusHandler
Con trỏ trỏ đến một hàm sẽ được gọi khi nhận được báo cáo trạng thái.

Hàm công khai

finalize(void)
void
Phương thức này sẽ dọn dẹp trạng thái nội bộ, bao gồm cả trạng thái đóng kết nối.
free(void)
void
Phương thức này sẽ giải phóng một đối tượng yêu cầu kết nối và đưa đối tượng đó trở lại nhóm.
init(WeaveServiceManager *aManager, const uint64_t & aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnIntf)
Phương thức này sẽ khởi tạo một thực thể ConnectRequest với các đối số được truyền vào.
isAllocatedTo(const uint64_t & aServiceEp, void *aAppState)
bool
Hàm này kiểm thử xem yêu cầu kết nối này có đang được dùng để kết nối với một điểm cuối dịch vụ cụ thể cho một thực thể ứng dụng của người tham gia hay không.
isFree(void)
bool
Hàm này kiểm thử xem yêu cầu kết nối hiện chưa được phân bổ hay chưa.
onConnectionComplete(WEAVE_ERROR aError)
void
Phương thức này là một thành phần phản hồi với lớp ứng dụng để kết nối với sự kiện hoàn tất.

Các thuộc tính công khai

mAppState

void * mAppState

mAuthMode

WeaveAuthMode mAuthMode

mConnIntf

InterfaceId mConnIntf

giao diện mà qua đó kết nối sẽ được thiết lập.

mConnectTimeoutMsecs

uint32_t mConnectTimeoutMsecs

thời gian chờ để lệnh gọi Connect thành công hoặc trả về lỗi.

mConnection

WeaveConnection * mConnection

Một kết nối để lưu trữ tại đây trong khi chờ hoàn tất.

mConnectionCompleteHandler

WeaveConnection::ConnectionCompleteFunct mConnectionCompleteHandler

Con trỏ trỏ đến một hàm sẽ được gọi khi hoàn tất kết nối đến điểm cuối của dịch vụ đích.

mServiceEp

uint64_t mServiceEp

mStatusHandler

StatusHandler mStatusHandler

Con trỏ trỏ đến một hàm sẽ được gọi khi nhận được báo cáo trạng thái.

Hàm công khai

hoàn tất

void finalize(
  void
)

Phương thức này sẽ dọn dẹp trạng thái nội bộ, bao gồm cả trạng thái đóng kết nối.

miễn phí

void free(
  void
)

Phương thức này sẽ giải phóng một đối tượng yêu cầu kết nối và đưa đối tượng đó trở lại nhóm.

khởi tạo

WEAVE_ERROR init(
  WeaveServiceManager *aManager,
  const uint64_t & aServiceEp,
  WeaveAuthMode aAuthMode,
  void *aAppState,
  StatusHandler aStatusHandler,
  WeaveConnection::ConnectionCompleteFunct aCompleteHandler,
  const uint32_t aConnectTimeoutMsecs,
  const InterfaceId aConnIntf
)

Phương thức này sẽ khởi tạo một thực thể ConnectRequest với các đối số được truyền vào.

Chi tiết
Tham số
[in] aManager
Con trỏ trỏ đến trình quản lý dịch vụ chứa mã.
[in] aServiceEp
Giá trị nhận dạng cho điểm cuối của dịch vụ dự kiến đối với yêu cầu kết nối này.
[in] aAuthMode
Mã mô tả cho phương pháp xác thực nên được sử dụng cho kết nối này.
[in] aAppState
Một con trỏ tuỳ ý sẽ được trả về trong các lệnh gọi lại.
[in] aStatusHandler
Con trỏ trỏ đến hàm callback có chức năng xử lý báo cáo trạng thái để phản hồi truy vấn điểm cuối của dịch vụ.
[in] aCompleteHandler
Con trỏ trỏ đến hàm callback xử lý sự kiện kết nối hoàn tất.
[in] aConnectTimeoutMsecs
Thời gian chờ để lệnh gọi Connect thành công hoặc trả về lỗi.
[in] aConnectIntf
Giao diện mà kết nối sẽ được thiết lập.
Trả về
WEAVE_NO_ERROR khi thành công; nếu không sẽ tạo ra mã lỗi tương ứng.

isAllocatedTo

bool isAllocatedTo(
  const uint64_t & aServiceEp,
  void *aAppState
)

Hàm này kiểm thử xem yêu cầu kết nối này có đang được dùng để kết nối với một điểm cuối dịch vụ cụ thể cho một thực thể ứng dụng của người tham gia hay không.

Chi tiết
Tham số
[in] aServiceEp
Mã điểm cuối của dịch vụ cần so sánh với nội dung mà yêu cầu kết nối này lưu giữ.
[in] aAppState
Con trỏ trỏ đến trạng thái ứng dụng, dùng để so sánh với nội dung của yêu cầu kết nối này.
Trả về
true nếu kiểm thử thành công, false nếu không thành công.

isFree

bool isFree(
  void
)

Hàm này kiểm thử xem yêu cầu kết nối hiện chưa được phân bổ hay chưa.

Chi tiết
Trả về
true nếu kiểm thử thành công, false nếu không thành công.

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

Phương thức này là một thành phần phản hồi với lớp ứng dụng để kết nối với sự kiện hoàn tất.

Hàm này sẽ gọi trình xử lý kết nối hoàn chỉnh được chỉ định tại verificationAndConnect() .