Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.

nl :: Dệt :: Hồ sơ :: WeaveTunnel :: WeaveTunnelAgent

Tóm lược

Người xây dựng và Người phá hủy

WeaveTunnelAgent (void)

Các loại công khai

AgentState {
kState_NotInitialized = 0,
kState_Initialized_NoTunnel = 1,
kState_PrimaryTunModeEstablished = 2,
kState_BkupOnlyTunModeEstablished = 3,
kState_PrimaryAndBkupTunModeEstablished = 4
}		 enum
Các trạng thái của Đại lý đường hầm liên quan đến (các) kết nối của nó với Dịch vụ.
AgentState typedef
Các trạng thái của Đại lý đường hầm liên quan đến (các) kết nối của nó với Dịch vụ.
OnServiceTunnelReconnectNotifyFunct )(TunnelType tunType, const char *reconnectHost, const uint16_t reconnectPort, void *appCtxt) typedef
void(*
Con trỏ hàm tới trình xử lý được đặt bởi lớp cao hơn khi nhận được Kết nối lại đường hầm từ Dịch vụ.
OnServiceTunnelStatusNotifyFunct )(WeaveTunnelConnectionMgr::TunnelConnNotifyReasons reason, WEAVE_ERROR err, void *appCtxt) typedef
void(*
Con trỏ hàm tới trình xử lý được thiết lập bởi lớp cao hơn để hoạt động dựa trên các thông báo khác nhau liên quan đến đường hầm tới Dịch vụ.
PlatformNetworkOnlineCheck )(TunnelType tunType, void *appCtxt) typedef
void(*
Con trỏ hàm tới một trình xử lý được cung cấp bởi ứng dụng để thực hiện kiểm tra trực tuyến mức mạng.
WeaveTunnelFlags {
kTunnelFlag_PrimaryEnabled = 0x01,
kTunnelFlag_BackupEnabled = 0x02,
kTunnelFlag_PrimaryRestricted = 0x04,
kTunnelFlag_BackupRestricted = 0x08
}		 enum
Các bit cờ của Weave Tunnel.
WeaveTunnelFlags typedef
Các bit cờ của Weave Tunnel.

Thuộc tính công cộng

NetworkOnlineCheck
OnServiceTunReconnectNotify
OnServiceTunStatusNotify
Con trỏ hàm tới trình xử lý được thiết lập bởi lớp cao hơn để hoạt động dựa trên các thông báo khác nhau liên quan đến đường hầm tới Dịch vụ.
mServiceMgr
WeaveServiceManager *
Con trỏ Trình quản lý Dịch vụ để sử dụng để tra cứu và kết nối với Dịch vụ.

Chức năng công cộng

DisablePrimaryTunnel (void)
void
Tắt đường hầm chính.
EnablePrimaryTunnel (void)
void
Bật đường hầm chính.
GetAgentStateName (const AgentState state)
const char *
Lấy tên WeaveTunnelAgentState.
GetTimeMsec (void)
uint64_t
Nhận thời gian hệ thống tính bằng mili giây.
GetWeaveTunnelAgentState (void)
Nhận trạng thái TunnelAgent.
Init (InetLayer *inet, WeaveExchangeManager *exchMgr, uint64_t dstNodeId, WeaveAuthMode authMode, WeaveServiceManager *svcMgr, const char *intfName, uint8_t role, void *appContext)
Khởi tạo tác nhân Tunnel.
Init (InetLayer *inet, WeaveExchangeManager *exchMgr, uint64_t dstNodeId, IPAddress dstIPAddr, WeaveAuthMode authMode, const char *intfName, uint8_t role, void *appContext)
Khởi tạo tác nhân Tunnel.
IsPrimaryTunnelEnabled (void) const
bool
Kiểm tra xem đường hầm chính đã được bật chưa.
IsPrimaryTunnelRoutingRestricted (void)
bool
Kiểm tra xem đường hầm chính có bị giới hạn định tuyến bởi dịch vụ hay không.
IsTunnelRoutingRestricted (void)
bool
Kiểm tra xem đường hầm có bị giới hạn định tuyến bởi dịch vụ hay không.
NetworkOnlineCheckResult (TunnelType tunType, bool isOnline)
void
Nền tảng gọi lại khi có kết quả của trình kiểm tra trực tuyến mạng.
ResetPrimaryReconnectBackoff (bool reconnectImmediately)
Đặt lại thời gian Kết nối lại cho đường hầm chính.
SetAuthMode (const WeaveAuthMode authMode)
void
Đặt WeaveAuthMode cho Tunnel.
SetDestination (const uint64_t nodeId, const IPAddress ipAddr, const uint16_t servicePort)
void
Đặt nodeId, IPAddress và cổng đích cho Tunnel.
SetTunnelingDeviceRole (const Role role)
void
Đặt vai trò thiết bị Đường hầm (BorderGateway, StandaloneDevice, MobileDevice) cho Đường hầm.
Shutdown (void)
Tắt tác nhân đường hầm.
StartServiceTunnel (void)
Khởi động Đường hầm Dịch vụ.
StartServiceTunnel (uint64_t dstNodeId, IPAddress dstIPAddr, WeaveAuthMode authMode)
Khởi động Đường hầm Dịch vụ.
StopServiceTunnel (void)
void
Đóng kết nối Đường hầm với Dịch vụ.
StopServiceTunnel ( WEAVE_ERROR err)
void
Đóng kết nối Đường hầm với Dịch vụ.

Các chức năng tĩnh công khai

RecvdFromShortcutUDPTunnel ( WeaveMessageLayer *msgLayer, PacketBuffer *message)
void
Xử lý để nhận các gói IPv6 đường hầm qua đường hầm UDP lối tắt giữa cổng biên giới và thiết bị di động và chuyển tiếp đến giao diện Tunnel EndPoint sau khi giải mã gói IPv6 thô từ bên trong tiêu đề đường hầm.
RecvdFromTunnelEndPoint ( TunEndPoint *tunEP, PacketBuffer *message)
void
Trình xử lý để nhận các gói IPv6 từ giao diện Tunnel EndPoint và chuyển tiếp tới Dịch vụ thông qua kết nối Service TCP sau khi đóng gói gói IPv6 bên trong tiêu đề đường hầm hoặc tới máy khách Di động qua đường hầm lối tắt.

Các loại công khai

AgentState

 AgentState

Các trạng thái của Đại lý đường hầm liên quan đến (các) kết nối của nó với Dịch vụ.

Tính chất
kState_BkupOnlyTunModeEstablished

Được sử dụng để chỉ ra rằng đường hầm Dự phòng tới Dịch vụ đã được thiết lập.

kState_Initialized_NoTunnel

Được sử dụng để chỉ ra rằng Tác nhân đường hầm được khởi tạo nhưng chưa có đường hầm nào được thiết lập.

kState_NotInitialized

Được sử dụng để chỉ ra rằng Tác nhân đường hầm không được khởi tạo.

kState_PrimaryAndBkupTunModeEstablished

Được sử dụng để chỉ ra rằng cả Đường hầm chính và Đường hầm dự phòng đã được thiết lập.

kState_PrimaryTunModeEstablished

Được sử dụng để chỉ ra rằng đường hầm Chính tới Dịch vụ đã được thiết lập.

AgentState

enum nl::Weave::Profiles::WeaveTunnel::WeaveTunnelAgent::AgentState AgentState

Các trạng thái của Đại lý đường hầm liên quan đến (các) kết nối của nó với Dịch vụ.

OnServiceTunnelReconnectNotifyFunct

void(* OnServiceTunnelReconnectNotifyFunct)(TunnelType tunType, const char *reconnectHost, const uint16_t reconnectPort, void *appCtxt)

Con trỏ hàm tới trình xử lý được đặt bởi lớp cao hơn khi nhận được Kết nối lại đường hầm từ Dịch vụ.

Chi tiết
Thông số
[in] tunType
Loại đường hầm, Chính hoặc Dự phòng.
[in] reconnectHost
Tên máy chủ do Dịch vụ cung cấp để kết nối lại.
[in] reconnectPort
Cổng đích do Dịch vụ cung cấp để kết nối lại.
[in] appCtxt
Một con trỏ đến một đối tượng ngữ cảnh ứng dụng

OnServiceTunnelStatusNotifyFunct

void(* OnServiceTunnelStatusNotifyFunct)(WeaveTunnelConnectionMgr::TunnelConnNotifyReasons reason, WEAVE_ERROR err, void *appCtxt)

Con trỏ hàm tới trình xử lý được thiết lập bởi lớp cao hơn để hoạt động dựa trên các thông báo khác nhau liên quan đến đường hầm tới Dịch vụ.

Chi tiết
Thông số
[in] reason
Lý do thông báo trạng thái cho ứng dụng.
[in] err
Đã gặp lỗi dệt, nếu có
[in] appCtxt
Một con trỏ đến một đối tượng ngữ cảnh ứng dụng

PlatformNetworkOnlineCheck

void(* PlatformNetworkOnlineCheck)(TunnelType tunType, void *appCtxt)

Con trỏ hàm tới một trình xử lý được cung cấp bởi ứng dụng để thực hiện kiểm tra trực tuyến mức mạng.

Chi tiết
Thông số
[in] tunType
Loại đường hầm, Chính hoặc Dự phòng.
[in] appCtxt
Một con trỏ đến một đối tượng ngữ cảnh ứng dụng

WeaveTunnelFlags

 WeaveTunnelFlags

Các bit cờ của Weave Tunnel.

Tính chất
kTunnelFlag_BackupEnabled

Đặt khi đường hầm dự phòng được bật.

kTunnelFlag_BackupRestricted

Đặt khi đường hầm dự phòng bị hạn chế định tuyến.

kTunnelFlag_PrimaryEnabled

Đặt khi đường hầm chính được bật.

kTunnelFlag_PrimaryRestricted

Đặt khi đường hầm chính bị hạn chế định tuyến.

WeaveTunnelFlags

enum nl::Weave::Profiles::WeaveTunnel::WeaveTunnelAgent::WeaveTunnelFlags WeaveTunnelFlags

Các bit cờ của Weave Tunnel.

Thuộc tính công cộng

NetworkOnlineCheck

PlatformNetworkOnlineCheck NetworkOnlineCheck

OnServiceTunReconnectNotify

OnServiceTunnelReconnectNotifyFunct OnServiceTunReconnectNotify

OnServiceTunStatusNotify

OnServiceTunnelStatusNotifyFunct OnServiceTunStatusNotify

Con trỏ hàm tới trình xử lý được thiết lập bởi lớp cao hơn để hoạt động dựa trên các thông báo khác nhau liên quan đến đường hầm tới Dịch vụ.

mServiceMgr

WeaveServiceManager * mServiceMgr

Con trỏ Trình quản lý Dịch vụ để sử dụng để tra cứu và kết nối với Dịch vụ.

Chức năng công cộng

DisablePrimaryTunnel

void DisablePrimaryTunnel(
  void
)

Tắt đường hầm chính.

Vô hiệu hóa Đường hầm chính.

EnablePrimaryTunnel

void EnablePrimaryTunnel(
  void
)

Bật đường hầm chính.

Bật đường hầm chính.

GetAgentStateName

const char * GetAgentStateName(
  const AgentState state
)

Lấy tên WeaveTunnelAgentState.

GetTimeMsec

uint64_t GetTimeMsec(
  void
)

Nhận thời gian hệ thống tính bằng mili giây.

Nhận thời gian hệ thống hoặc thời gian đơn điệu tính bằng mili giây nếu thời gian hệ thống không khả dụng.

GetWeaveTunnelAgentState

AgentState GetWeaveTunnelAgentState(
  void
)

Nhận trạng thái TunnelAgent.

Chi tiết
Lợi nhuận
AgentState tình trạng hiện tại của WeaveTunnelAgent .

Trong đó

WEAVE_ERROR Init(
  InetLayer *inet,
  WeaveExchangeManager *exchMgr,
  uint64_t dstNodeId,
  WeaveAuthMode authMode,
  WeaveServiceManager *svcMgr,
  const char *intfName,
  uint8_t role,
  void *appContext
)

Khởi tạo tác nhân Tunnel.

Điều này tạo ra te đối tượng Tunnel endpoint, thiết lập giao diện đường hầm, khởi tạo các biến thành viên, callbacks và WeaveTunnelControl .

Trong đó

WEAVE_ERROR Init(
  InetLayer *inet,
  WeaveExchangeManager *exchMgr,
  uint64_t dstNodeId,
  IPAddress dstIPAddr,
  WeaveAuthMode authMode,
  const char *intfName,
  uint8_t role,
  void *appContext
)

Khởi tạo tác nhân Tunnel.

Điều này tạo ra te đối tượng Tunnel endpoint, thiết lập giao diện đường hầm, khởi tạo các biến thành viên, callbacks và WeaveTunnelControl .

IsPrimaryTunnelEnabled

bool IsPrimaryTunnelEnabled(
  void
) const

Kiểm tra xem đường hầm chính đã được bật chưa.

Chi tiết
Lợi nhuận
true nếu nó được kích hoạt, ngược lại false.

IsPrimaryTunnelRoutingRestricted

bool IsPrimaryTunnelRoutingRestricted(
  void
)

Kiểm tra xem đường hầm chính có bị giới hạn định tuyến bởi dịch vụ hay không.

Kiểm tra xem đường hầm chính có bị giới hạn định tuyến hay không.

Chi tiết
Lợi nhuận
true nếu đường hầm chính được thiết lập nhưng phải tuân theo các giới hạn định tuyến của dịch vụ.

IsTunnelRoutingRestricted

bool IsTunnelRoutingRestricted(
  void
)

Kiểm tra xem đường hầm có bị giới hạn định tuyến bởi dịch vụ hay không.

Kiểm tra xem đường hầm có bị giới hạn định tuyến hay không.

Chi tiết
Lợi nhuận
true nếu đường hầm chính hoặc đường hầm dự phòng được thiết lập và phải tuân theo các giới hạn định tuyến của dịch vụ.

NetworkOnlineCheckResult

void NetworkOnlineCheckResult(
  TunnelType tunType,
  bool isOnline
)

Nền tảng gọi lại khi có kết quả của trình kiểm tra trực tuyến mạng.

Chi tiết
Thông số
[in] tunType
Loại đường hầm tương ứng với giao diện mà quá trình kiểm tra kết nối mạng được thực hiện.
[in] isOnline
Đúng nếu mạng trực tuyến, sai nếu ngược lại.

ResetPrimaryReconnectBackoff

WEAVE_ERROR ResetPrimaryReconnectBackoff(
  bool reconnectImmediately
)

Đặt lại thời gian Kết nối lại cho đường hầm chính.

Chi tiết
Thông số
[in] reconnectImmediately
Đúng nếu được yêu cầu kết nối lại ngay lập tức, nếu không thì sử dụng thời gian chờ kết nối lại đã định cấu hình.

SetAuthMode

void SetAuthMode(
  const WeaveAuthMode authMode
)

Đặt WeaveAuthMode cho Tunnel.

Chi tiết
Thông số
[in] authMode
Chế độ xác thực dệt được sử dụng với ngang hàng.

Đích đã được cài

void SetDestination(
  const uint64_t nodeId,
  const IPAddress ipAddr,
  const uint16_t servicePort
)

Đặt nodeId, IPAddress và cổng đích cho Tunnel.

Đặt nodeId và IPAddress đích cho Tunnel.

Chi tiết
Thông số
[in] nodeId
ID nút của nút đích.
[in] ipAddr
Địa chỉ IP của nút đích.
[in] servicePort
Cổng của nút đích.

SetTunnelingDeviceRole

void SetTunnelingDeviceRole(
  const Role role
)

Đặt vai trò thiết bị Đường hầm (BorderGateway, StandaloneDevice, MobileDevice) cho Đường hầm.

Đặt vai trò thiết bị Tạo đường hầm (BorderGateway so với Độc lập) cho Đường hầm.

Chi tiết
Thông số
[in] role
Vai trò do Tunnel Agent đảm nhận; Cửa khẩu, Thiết bị độc lập hoặc Di động.

Tắt

WEAVE_ERROR Shutdown(
  void
)

Tắt tác nhân đường hầm.

Điều này ngắt kết nối với Dịch vụ và đóng giao diện TunEndPoint sau khi loại bỏ các địa chỉ và tuyến đường được liên kết với giao diện đường hầm.

Điều này ngắt kết nối với Dịch vụ và đóng giao diện TunEndPoint sau khi loại bỏ các địa chỉ và tuyến đường được liên kết với giao diện đường hầm.

Chi tiết
Lợi nhuận
WEAVE_NO_ERROR thành công, nếu không, một loại WEAVE_ERROR tương ứng.

StartServiceTunnel

WEAVE_ERROR StartServiceTunnel(
  void
)

Khởi động Đường hầm Dịch vụ.

Điều này kích hoạt đường hầm và cố gắng thiết lập kết nối với Dịch vụ.

Điều này cố gắng thiết lập kết nối với Dịch vụ và cũng đặt tuyến đường kết cấu đến giao diện đường hầm.

Chi tiết
Lợi nhuận
WEAVE_NO_ERROR thành công, nếu không, một loại WEAVE_ERROR tương ứng.

StartServiceTunnel

WEAVE_ERROR StartServiceTunnel(
  uint64_t dstNodeId,
  IPAddress dstIPAddr,
  WeaveAuthMode authMode
)

Khởi động Đường hầm Dịch vụ.

Điều này kích hoạt đường hầm và cố gắng thiết lập kết nối với Dịch vụ.

StopServiceTunnel

void StopServiceTunnel(
  void
)

Đóng kết nối Đường hầm với Dịch vụ.

StopServiceTunnel

void StopServiceTunnel(
  WEAVE_ERROR err
)

Đóng kết nối Đường hầm với Dịch vụ.

Chi tiết
Thông số
[in] err
WEAVE_NO_ERROR nếu không có lý do cụ thể nào cho yêu cầu StopServiceTunnel này, nếu không nguyên nhân lỗi sẽ được chuyển sang.

WeaveTunnelAgent

 WeaveTunnelAgent(
  void
)

Các chức năng tĩnh công khai

RecvdFromShortcutUDPTunnel

void RecvdFromShortcutUDPTunnel(
  WeaveMessageLayer *msgLayer,
  PacketBuffer *message
)

Trình xử lý để nhận các gói IPv6 đường hầm qua đường hầm UDP lối tắt giữa cổng biên giới và thiết bị di động và chuyển tiếp đến giao diện Tunnel EndPoint sau khi giải mã gói IPv6 thô từ bên trong tiêu đề đường hầm.

Xử lý để nhận các gói IPv6 đường hầm từ kết nối Service TCP và chuyển tiếp đến giao diện Tunnel EndPoint sau khi giải mã gói IPv6 thô từ bên trong tiêu đề đường hầm.

Chi tiết
Thông số
[in] con
Một con trỏ tới các WeaveConnection đối tượng.
[in] msgInfo
Một con trỏ tới các WeaveMessageInfo đối tượng.
[in] message
Một con trỏ tới đối tượng PacketBuffer đang giữ gói IPv6 đường hầm.

RecvdFromTunnelEndPoint

void RecvdFromTunnelEndPoint(
  TunEndPoint *tunEP,
  PacketBuffer *message
)

Trình xử lý để nhận các gói IPv6 từ giao diện Tunnel EndPoint và chuyển tiếp đến Dịch vụ thông qua kết nối Service TCP sau khi đóng gói gói IPv6 bên trong tiêu đề đường hầm hoặc tới máy khách Di động qua đường hầm lối tắt.

Trình xử lý để nhận các gói IPv6 từ giao diện Tunnel EndPoint và chuyển tiếp tới Dịch vụ thông qua kết nối Service TCP sau khi đóng gói gói IPv6 bên trong tiêu đề đường hầm hoặc tới máy khách Di động qua đường hầm cục bộ.

Nếu kết nối Dịch vụ chưa được thiết lập, thông báo sẽ được xếp hàng đợi cho đến khi kết nối được thiết lập. Đối với đường hầm tới thiết bị khách Di động, bảng hàng xóm nexthop được tham chiếu.

Nếu kết nối Dịch vụ chưa được thiết lập, thông báo sẽ được xếp hàng đợi cho đến khi kết nối được thiết lập. Đối với đường hầm tới thiết bị khách Di động, bảng lân cận nexthop được tham chiếu.

Chi tiết
Thông số
[in] tunEP
Một con trỏ đến đối tượng TunEndPoint.
[in] message
Một con trỏ đến đối tượng PacketBuffer đang giữ gói IPv6 thô.