Giải pháp chung
Mô-đun này bao gồm các hàm cho tất cả vai trò Thread.
Tóm tắt
Nhà xuất bản dữ liệu mạng cung cấp cơ chế để giới hạn số lượng mục nhập Dịch vụ và/hoặc Tiền tố (tiền tố trên lưới hoặc tuyến bên ngoài) tương tự nhau trong Dữ liệu mạng chuỗi bằng cách giám sát Dữ liệu mạng và quản lý xem liệu hoặc thời điểm thêm hoặc xoá mục nhập.
Tất cả hàm trong mô-đun này đều yêu cầu bật OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE
.
Typedef |
|
---|---|
otBorderRouterConfig
|
typedefstruct otBorderRouterConfig
Đại diện cho cấu hình Bộ định tuyến đường viền. |
otDetachGracefullyCallback)(void *aContext)
|
typedefvoid(*
Lệnh gọi lại này thông báo cho ứng dụng rằng quá trình tách đã hoàn tất. |
otExternalRouteConfig
|
typedefstruct otExternalRouteConfig
Đại diện cho cấu hình Tuyến bên ngoài. |
otIpCounters
|
typedefstruct otIpCounters
Đại diện cho bộ đếm cấp IP. |
otLeaderData
|
typedefstruct otLeaderData
Đại diện cho dữ liệu của người lãnh đạo luồng. |
otLinkModeConfig
|
typedefstruct otLinkModeConfig
Đại diện cho cấu hình Chế độ liên kết MLE. |
otLowpanContextInfo
|
typedefstruct otLowpanContextInfo
Đại diện cho thông tin mã ngữ cảnh 6LoWPAN liên kết với một tiền tố trong dữ liệu mạng. |
otMleCounters
|
typedefstruct otMleCounters
Đại diện cho bộ đếm Thread MLE. |
otNeighborInfoIterator
|
typedefint16_t
Dùng để lặp lại bảng lân cận. |
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
|
typedefvoid(*
Loại con trỏ xác định lệnh gọi lại dùng để thông báo khi một mục "Dịch vụ DNS/SRP" được thêm vào hoặc bị xoá khỏi Dữ liệu mạng luồng. |
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
|
typedefvoid(*
Loại con trỏ xác định lệnh gọi lại dùng để thông báo khi một mục nhập tiền tố (trên lưới hoặc tuyến bên ngoài) được thêm vào hoặc bị xoá khỏi Dữ liệu mạng luồng. |
otNetDataPublisherEvent
|
typedef Đại diện cho các sự kiện được báo cáo từ lệnh gọi lại của Nhà xuất bản. |
otNetworkDataIterator
|
typedefuint32_t
Được dùng để lặp lại thông tin Dữ liệu mạng. |
otNetworkDiagChildEntry
|
typedefstruct otNetworkDiagChildEntry
Đại diện cho mục nhập bảng con chẩn đoán mạng. |
otNetworkDiagConnectivity
|
typedefstruct otNetworkDiagConnectivity
Đại diện cho giá trị Kết nối chẩn đoán mạng. |
otNetworkDiagIterator
|
typedefuint16_t
Dùng để lặp lại thông qua TLV chẩn đoán mạng. |
otNetworkDiagMacCounters
|
typedefstruct otNetworkDiagMacCounters
Đại diện cho giá trị Bộ đếm Mac chẩn đoán mạng. |
otNetworkDiagMleCounters
|
typedefstruct otNetworkDiagMleCounters
Đại diện cho giá trị Bộ đếm MLE Chẩn đoán mạng. |
otNetworkDiagRoute
|
typedefstruct otNetworkDiagRoute
Biểu thị giá trị TLV của Tuyến chẩn đoán mạng. |
otNetworkDiagRouteData
|
typedefstruct otNetworkDiagRouteData
Đại diện cho dữ liệu Tuyến chẩn đoán mạng. |
otNetworkDiagTlv
|
typedefstruct otNetworkDiagTlv
Đại diện cho một TLV chẩn đoán mạng. |
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
|
typedefvoid(*
Con trỏ được gọi khi nhận được phản hồi Nhận dữ liệu chẩn đoán mạng. |
otRoutePreference
|
typedefenum otRoutePreference
|
otServerConfig
|
typedefstruct otServerConfig
Đại diện cho cấu hình Máy chủ. |
otServiceConfig
|
typedefstruct otServiceConfig
Đại diện cho cấu hình Dịch vụ. |
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
|
typedefvoid(*
Loại con trỏ xác định lệnh gọi lại để thông báo kết quả của yêu cầu otThreadLocateAnycastDestination() . |
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
|
typedefvoid(*
Con trỏ sẽ được gọi mỗi khi nhận được thông báo Yêu cầu khám phá MLE. |
otThreadDiscoveryRequestInfo
|
typedefstruct otThreadDiscoveryRequestInfo
Đại diện cho dữ liệu Yêu cầu khám phá luồng. |
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
|
typedefvoid(*
Con trỏ sẽ được gọi mỗi khi nhận được thông báo Phản hồi của cha mẹ MLE. |
otThreadParentResponseInfo
|
typedefstruct otThreadParentResponseInfo
Đại diện cho dữ liệu Phản hồi của cha mẹ MLE. |
Hàm |
|
---|---|
otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)
|
void
Chuyển đổi thời lượng
uint32_t (tính bằng giây) thành chuỗi mà con người đọc được. |
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
bool
Kiểm tra xem một Tiền tố nhất định có thể đóng vai trò như một tiền tố OMR hợp lệ hay không, đồng thời Dữ liệu mạng của Nhà lãnh đạo có chứa tiền tố này hay không.
|
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
|
Cung cấp bản sao đầy đủ hoặc ổn định cho Dữ liệu mạng luồng của Phân vùng.
|
otNetDataGetCommissioningDataset(otInstance *aInstance, otCommissioningDataset *aDataset)
|
void
Nhận Tập dữ liệu được uỷ quyền từ Dữ liệu mạng của phân vùng.
|
otNetDataGetLength(otInstance *aInstance)
|
uint8_t
Lấy độ dài hiện tại (số byte) của Dữ liệu mạng chuỗi của Phân vùng.
|
otNetDataGetMaxLength(otInstance *aInstance)
|
uint8_t
Nhận thời lượng tối đa quan sát được của Dữ liệu mạng luồng kể từ khi khởi chạy ngăn xếp OT (trước) hoặc kể từ lần gọi gần đây nhất đến
otNetDataResetMaxLength() . |
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
|
Nhận thông tin mã ngữ cảnh 6LoWPAN tiếp theo trong Dữ liệu mạng của phân vùng.
|
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
|
Nhận tiền tố lưới tiếp theo trong Dữ liệu mạng của phân vùng.
|
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
|
Nhận tuyến bên ngoài tiếp theo trong Dữ liệu mạng của phân vùng.
|
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
|
Nhận dịch vụ tiếp theo trong Dữ liệu mạng của phân vùng.
|
otNetDataGetStableVersion(otInstance *aInstance)
|
uint8_t
Tải phiên bản dữ liệu mạng ổn định.
|
otNetDataGetVersion(otInstance *aInstance)
|
uint8_t
Tải phiên bản dữ liệu mạng.
|
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
|
bool
Cho biết liệu mục "Dịch vụ DNS/SRP" hiện có được thêm vào Dữ liệu mạng luồng hay không.
|
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
bool
Cho biết liệu mục nhập tiền tố đã phát hành (trên lưới hoặc tuyến bên ngoài) hiện có được thêm vào Dữ liệu mạng luồng hay không.
|
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
|
void
Yêu cầu xuất bản "Địa chỉ Anycast của dịch vụ DNS/SRP" trong Dữ liệu mạng theo luồng.
|
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
|
void
Yêu cầu xuất bản "Địa chỉ Unicast của dịch vụ DNS/SRP" trong Dữ liệu mạng luồng.
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
|
void
Yêu cầu xuất bản "Địa chỉ Unicast của dịch vụ DNS/SRP" trong Dữ liệu mạng luồng.
|
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
|
Yêu cầu xuất bản tiền tố tuyến bên ngoài trong Dữ liệu mạng luồng.
|
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
|
Yêu cầu xuất bản một tiền tố trên lưới trong Dữ liệu mạng luồng.
|
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
|
Thay thế một tuyến bên ngoài đã phát hành trước đó trong Thread Network Data (Dữ liệu mạng luồng).
|
otNetDataResetMaxLength(otInstance *aInstance)
|
void
Đặt lại thời lượng tối đa được theo dõi cho Dữ liệu mạng luồng.
|
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
|
void
Đặt lệnh gọi lại để thông báo khi một "Dịch vụ DNS/SRP" đã phát hành thực sự được thêm vào hoặc bị xoá khỏi Dữ liệu mạng luồng.
|
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
|
void
Đặt lệnh gọi lại để thông báo khi một mục nhập tiền tố đã xuất bản thực sự được thêm vào hoặc bị xoá khỏi Dữ liệu mạng luồng.
|
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Kiểm tra xem dữ liệu chỉ đạo có bao gồm Ký tự kết hợp hay không.
|
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
|
Kiểm tra xem dữ liệu chỉ đạo có bao gồm Trình kết hợp có giá trị rõ ràng nhất định hay không.
|
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
|
void
Huỷ xuất bản bất kỳ mục nhập Dịch vụ DNS/SRP (Anycast hoặc Unicast) nào đã thêm trước đó từ Thread Network Data.
|
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
|
Huỷ xuất bản On-Mesh hoặc Tiền tố bên ngoài đã xuất bản trước đó.
|
otThreadBecomeChild(otInstance *aInstance)
|
Cố gắng đính kèm lại với tư cách là trẻ.
|
otThreadBecomeDetached(otInstance *aInstance)
|
Tách khỏi mạng Thread.
|
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
|
Thông báo cho các nút khác trong mạng (nếu có), sau đó dừng hoạt động của giao thức Thread.
|
otThreadDeviceRoleToString(otDeviceRole aRole)
|
const char *
Chuyển đổi vai trò của thiết bị thành chuỗi mà con người đọc được.
|
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
|
Bắt đầu quét luồng công cụ Khám phá.
|
otThreadGetChildTimeout(otInstance *aInstance)
|
uint32_t
Lấy Thời gian chờ của chuỗi con (tính bằng giây) được dùng khi thao tác ở vai trò Con.
|
otThreadGetDeviceRole(otInstance *aInstance)
|
Nhận vai trò thiết bị.
|
otThreadGetDomainName(otInstance *aInstance)
|
const char *
Lấy tên miền của luồng.
|
otThreadGetExtendedPanId(otInstance *aInstance)
|
const otExtendedPanId *
Lấy mã PAN mở rộng theo chuẩn IEEE 802.15.4.
|
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
|
const otIp6InterfaceIdentifier *
Nhận Giá trị nhận dạng giao diện được chỉ định theo cách thủ công cho Địa chỉ Unicast của miền Thread.
|
otThreadGetIp6Counters(otInstance *aInstance)
|
const otIpCounters *
Lấy bộ đếm IPv6.
|
otThreadGetKeySequenceCounter(otInstance *aInstance)
|
uint32_t
Lấy thrKeySequenceCounter.
|
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
|
uint32_t
Nhận thrKeySwitchGuardTime (theo giờ).
|
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
|
Nhận dữ liệu về người lãnh đạo chuỗi.
|
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
|
Trả về một con trỏ đến RLOC của Người lãnh đạo.
|
otThreadGetLeaderRouterId(otInstance *aInstance)
|
uint8_t
Lấy mã bộ định tuyến của người lãnh đạo.
|
otThreadGetLeaderWeight(otInstance *aInstance)
|
uint8_t
Xem trọng lực của người lãnh đạo.
|
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
|
const otIp6Address *
Lấy địa chỉ phát đa hướng của Thread Link-Local All Thread Nodes.
|
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
|
const otIp6Address *
Lấy địa chỉ IPv6 cục bộ của Thread.
|
otThreadGetLinkMode(otInstance *aInstance)
|
Tải cấu hình Chế độ liên kết MLE.
|
otThreadGetMaxTimeInQueue(otInstance *aInstance)
|
uint32_t
Nhận thời gian trong hàng đợi tối đa của các thư trong hàng đợi TX.
|
otThreadGetMeshLocalEid(otInstance *aInstance)
|
const otIp6Address *
Lấy địa chỉ EID cục bộ Mesh.
|
otThreadGetMeshLocalPrefix(otInstance *aInstance)
|
const otMeshLocalPrefix *
Trả về một con trỏ cho Tiền tố cục bộ dạng lưới (Mesh Local Prefix).
|
otThreadGetMleCounters(otInstance *aInstance)
|
const otMleCounters *
Lấy bộ đếm Thread MLE.
|
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
|
void
Lấy khoá mạng luồng.
|
otThreadGetNetworkKeyRef(otInstance *aInstance)
|
Tải
otNetworkKeyRef cho Khoá mạng luồng. |
otThreadGetNetworkName(otInstance *aInstance)
|
const char *
Lấy tên mạng luồng.
|
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
|
Nhận được TLV Network Chẩn đoán mạng tiếp theo trong thông báo.
|
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
|
Nhận thông tin về người lân cận tiếp theo.
|
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
|
Hàm này truy xuất RSSI trung bình cho Thread Parent.
|
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
|
Hàm này truy xuất thông tin chẩn đoán cho Bộ định tuyến luồng dưới dạng thành phần mẹ.
|
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
|
Hàm này truy xuất RSSI của gói cuối cùng từ Thread Parent.
|
otThreadGetPartitionId(otInstance *aInstance)
|
uint32_t
Lấy mã phân vùng.
|
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
|
const otIp6Address *
Lấy địa chỉ phát đa hướng của Thread Realm-Local All Thread Nodes.
|
otThreadGetRloc(otInstance *aInstance)
|
const otIp6Address *
Lấy địa chỉ Bộ định tuyến luồng (RLOC).
|
otThreadGetRloc16(otInstance *aInstance)
|
uint16_t
Tải RLOC16.
|
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
|
Truy xuất ALOC của dịch vụ cho Mã dịch vụ đã cho.
|
otThreadGetTimeInQueueHistogram(otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
|
const uint32_t *
Lấy biểu đồ thời gian trong hàng đợi cho các thư trong hàng đợi TX.
|
otThreadGetVendorModel(otInstance *aInstance)
|
const char *
Lấy chuỗi mô hình của nhà cung cấp.
|
otThreadGetVendorName(otInstance *aInstance)
|
const char *
Lấy chuỗi tên nhà cung cấp.
|
otThreadGetVendorSwVersion(otInstance *aInstance)
|
const char *
Lấy chuỗi phiên bản sw của nhà cung cấp.
|
otThreadGetVersion(void)
|
uint16_t
Lấy phiên bản giao thức Thread.
|
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
|
bool
Cho biết liệu yêu cầu định vị Anycast có đang được xử lý hay không.
|
otThreadIsDiscoverInProgress(otInstance *aInstance)
|
bool
Xác định xem quá trình Khám phá luồng MLE có đang diễn ra hay không.
|
otThreadIsSingleton(otInstance *aInstance)
|
bool
Cho biết liệu một nút có phải là bộ định tuyến duy nhất trên mạng hay không.
|
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
|
Yêu cầu định vị đích đến gần nhất của một địa chỉ Anycast đã cho.
|
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
|
void
Đăng ký lệnh gọi lại để nhận dữ liệu Phản hồi của cha mẹ MLE.
|
otThreadResetIp6Counters(otInstance *aInstance)
|
void
Đặt lại bộ đếm IPv6.
|
otThreadResetMleCounters(otInstance *aInstance)
|
void
Đặt lại bộ đếm Thread MLE.
|
otThreadResetTimeInQueueStat(otInstance *aInstance)
|
void
Đặt lại số liệu thống kê về thời gian trong hàng đợi của hàng đợi TX.
|
otThreadSearchForBetterParent(otInstance *aInstance)
|
Bắt đầu quá trình để trẻ tìm kiếm cha mẹ tốt hơn trong khi vẫn tiếp tục gắn bó với cha mẹ hiện tại.
|
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
|
void
Gửi thư Thông báo địa chỉ chủ động ( {6/}_NTF.ntf).
|
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
|
Gửi yêu cầu Nhận chẩn đoán mạng.
|
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
|
Gửi yêu cầu Đặt lại chẩn đoán mạng.
|
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
|
Gửi thông báo Chủ động thông báo về trục chính (PRO_BB.ntf) trên đường liên kết Backbone.
|
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
|
void
Đặt Thời gian chờ của chuỗi con (tính bằng giây) được dùng khi hoạt động ở vai trò Con.
|
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
|
void
Đặt lệnh gọi lại để nhận dữ liệu Yêu cầu khám phá MLE.
|
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
|
Đặt tên miền của luồng.
|
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
|
Bắt đầu hoạt động đối với giao thức Thread.
|
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
|
Đặt Mã PAN mở rộng theo chuẩn IEEE 802.15.4.
|
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
|
Đặt hoặc xoá Giá trị nhận dạng giao diện được chỉ định theo cách thủ công cho Địa chỉ Unicast của miền luồng.
|
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
|
Đặt Thread Joiner Quảng cáo khi khám phá mạng Thread.
|
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
|
void
Đặt thrKeySequenceCounter.
|
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
|
void
Đặt thrKeySwitchGuardTime (theo giờ).
|
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
|
Đặt cấu hình Chế độ liên kết MLE.
|
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
|
Đặt Tiền tố cục bộ Mesh.
|
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
|
Đặt khoá mạng luồng.
|
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
|
Đặt Khoá mạng luồng làm
otNetworkKeyRef . |
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
|
Đặt tên mạng chuỗi.
|
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
|
Đặt chuỗi mô hình nhà cung cấp.
|
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
|
Đặt chuỗi tên nhà cung cấp.
|
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
|
Đặt chuỗi phiên bản phần mềm của nhà cung cấp.
|
Cấu trúc |
|
---|---|
otBorderRouterConfig |
Đại diện cho cấu hình Bộ định tuyến đường viền. |
otExternalRouteConfig |
Đại diện cho cấu hình Tuyến bên ngoài. |
otIpCounters |
Đại diện cho bộ đếm cấp IP. |
otLeaderData |
Đại diện cho dữ liệu của người lãnh đạo luồng. |
otLinkModeConfig |
Đại diện cho cấu hình Chế độ liên kết MLE. |
otLowpanContextInfo |
Đại diện cho thông tin mã ngữ cảnh 6LoWPAN liên kết với một tiền tố trong dữ liệu mạng. |
otMleCounters |
Đại diện cho bộ đếm Thread MLE. |
otNeighborInfo |
Lưu giữ thông tin chẩn đoán cho nút Luồng lân cận. |
otNetworkDiagChildEntry |
Đại diện cho mục nhập bảng con chẩn đoán mạng. |
otNetworkDiagConnectivity |
Đại diện cho giá trị Kết nối chẩn đoán mạng. |
otNetworkDiagMacCounters |
Đại diện cho giá trị Bộ đếm Mac chẩn đoán mạng. |
otNetworkDiagMleCounters |
Đại diện cho giá trị Bộ đếm MLE Chẩn đoán mạng. |
otNetworkDiagRoute |
Biểu thị giá trị TLV của Tuyến chẩn đoán mạng. |
otNetworkDiagRouteData |
Đại diện cho dữ liệu Tuyến chẩn đoán mạng. |
otNetworkDiagTlv |
Đại diện cho một TLV chẩn đoán mạng. |
otRouterInfo |
Lưu giữ thông tin chẩn đoán cho Bộ định tuyến luồng. |
otServerConfig |
Đại diện cho cấu hình Máy chủ. |
otServiceConfig |
Đại diện cho cấu hình Dịch vụ. |
otThreadDiscoveryRequestInfo |
Đại diện cho dữ liệu Yêu cầu khám phá luồng. |
otThreadParentResponseInfo |
Đại diện cho dữ liệu Phản hồi của cha mẹ MLE. |
Bảng liệt kê
enum ẩn danh
anonymous enum
otDeviceRole
otDeviceRole
Đại diện cho vai trò của thiết bị Thread.
Thuộc tính | |
---|---|
OT_DEVICE_ROLE_CHILD
|
Vai trò con trong Thread. |
OT_DEVICE_ROLE_DETACHED
|
Hiện không tham gia vào phân vùng/mạng Thread. |
OT_DEVICE_ROLE_DISABLED
|
Ngăn xếp luồng đã tắt. |
OT_DEVICE_ROLE_LEADER
|
Vai trò Người lãnh đạo luồng. |
OT_DEVICE_ROLE_ROUTER
|
Vai trò Bộ định tuyến luồng. |
otNetDataPublisherEvent
otNetDataPublisherEvent
Đại diện cho các sự kiện được báo cáo từ lệnh gọi lại của Nhà xuất bản.
Thuộc tính | |
---|---|
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED
|
Mục đã xuất bản sẽ được thêm vào Dữ liệu mạng chuỗi. |
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED
|
Mục đã xuất bản sẽ bị xoá khỏi Dữ liệu mạng chuỗi. |
otRoutePreference
otRoutePreference
Xác định các giá trị hợp lệ cho mPreference
trong otExternalRouteConfig
và otBorderRouterConfig
.
Thuộc tính | |
---|---|
OT_ROUTE_PREFERENCE_HIGH
|
Tùy chọn tuyến đường cao. |
OT_ROUTE_PREFERENCE_LOW
|
Lựa chọn ưu tiên về tuyến đường thấp. |
OT_ROUTE_PREFERENCE_MED
|
Tùy chọn tuyến đường trung bình. |
Typedef
otBorderRouterConfig
struct otBorderRouterConfig otBorderRouterConfig
Đại diện cho cấu hình Bộ định tuyến đường viền.
otDetachGracefullyCallback
void(* otDetachGracefullyCallback)(void *aContext)
Lệnh gọi lại này thông báo cho ứng dụng rằng quá trình tách đã hoàn tất.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
otExternalRouteConfig
struct otExternalRouteConfig otExternalRouteConfig
Đại diện cho cấu hình Tuyến bên ngoài.
otLinkModeConfig
struct otLinkModeConfig otLinkModeConfig
Đại diện cho cấu hình Chế độ liên kết MLE.
otLowpanContextInfo
struct otLowpanContextInfo otLowpanContextInfo
Đại diện cho thông tin mã ngữ cảnh 6LoWPAN liên kết với một tiền tố trong dữ liệu mạng.
otNeighborInfoIterator
int16_t otNeighborInfoIterator
Dùng để lặp lại bảng lân cận.
otNetDataDnsSrpServicePublisherCallback
void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
Loại con trỏ xác định lệnh gọi lại dùng để thông báo khi một mục "Dịch vụ DNS/SRP" được thêm vào hoặc bị xoá khỏi Dữ liệu mạng luồng.
Khi xoá, lệnh gọi lại sẽ được gọi bất kể mục nhập có bị Publisher
xoá hay không (ví dụ: khi có quá nhiều mục nhập tương tự đã có trong Dữ liệu mạng) hay thông qua một lệnh gọi rõ ràng để huỷ xuất bản mục nhập (chẳng hạn như lệnh gọi đến otNetDataUnpublishDnsSrpService()
).
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otNetDataPrefixPublisherCallback
void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)
Loại con trỏ xác định lệnh gọi lại dùng để thông báo khi một mục nhập tiền tố (trên lưới hoặc tuyến bên ngoài) được thêm vào hoặc bị xoá khỏi Dữ liệu mạng luồng.
Khi xoá, lệnh gọi lại sẽ được gọi bất kể mục nhập có bị Publisher
xoá hay không (ví dụ: khi có quá nhiều mục nhập tương tự đã có trong Dữ liệu mạng) hay thông qua một lệnh gọi rõ ràng để huỷ xuất bản mục nhập.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
otNetDataPublisherEvent
enum otNetDataPublisherEvent otNetDataPublisherEvent
Đại diện cho các sự kiện được báo cáo từ lệnh gọi lại của Nhà xuất bản.
otNetworkDataIterator
uint32_t otNetworkDataIterator
Được dùng để lặp lại thông tin Dữ liệu mạng.
otNetworkDiagChildEntry
struct otNetworkDiagChildEntry otNetworkDiagChildEntry
Đại diện cho mục nhập bảng con chẩn đoán mạng.
otNetworkDiagConnectivity
struct otNetworkDiagConnectivity otNetworkDiagConnectivity
Đại diện cho giá trị Kết nối chẩn đoán mạng.
otNetworkDiagIterator
uint16_t otNetworkDiagIterator
Dùng để lặp lại thông qua TLV chẩn đoán mạng.
otNetworkDiagMacCounters
struct otNetworkDiagMacCounters otNetworkDiagMacCounters
Đại diện cho giá trị Bộ đếm Mac chẩn đoán mạng.
Xem RFC 2863 để biết định nghĩa về các trường thành viên.
otNetworkDiagMleCounters
struct otNetworkDiagMleCounters otNetworkDiagMleCounters
Đại diện cho giá trị Bộ đếm MLE Chẩn đoán mạng.
otNetworkDiagRoute
struct otNetworkDiagRoute otNetworkDiagRoute
Biểu thị giá trị TLV của Tuyến chẩn đoán mạng.
otNetworkDiagRouteData
struct otNetworkDiagRouteData otNetworkDiagRouteData
Đại diện cho dữ liệu Tuyến chẩn đoán mạng.
otReceiveDiagnosticGetCallback
void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
Con trỏ được gọi khi nhận được phản hồi Nhận dữ liệu chẩn đoán mạng.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
otRoutePreference
enum otRoutePreference otRoutePreference
Xác định các giá trị hợp lệ cho mPreference
trong otExternalRouteConfig
và otBorderRouterConfig
.
otThreadAnycastLocatorCallback
void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
Loại con trỏ xác định lệnh gọi lại để thông báo kết quả của yêu cầu otThreadLocateAnycastDestination()
.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
otThreadDiscoveryRequestCallback
void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
Con trỏ sẽ được gọi mỗi khi nhận được thông báo Yêu cầu khám phá MLE.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadDiscoveryRequestInfo
struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo
Đại diện cho dữ liệu Yêu cầu khám phá luồng.
otThreadParentResponseCallback
void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
Con trỏ sẽ được gọi mỗi khi nhận được thông báo Phản hồi của cha mẹ MLE.
Thành phần này được dùng trong otThreadRegisterParentResponseCallback()
.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadParentResponseInfo
struct otThreadParentResponseInfo otThreadParentResponseInfo
Đại diện cho dữ liệu Phản hồi của cha mẹ MLE.
Hàm
otConvertDurationInSecondsToString
void otConvertDurationInSecondsToString( uint32_t aDuration, char *aBuffer, uint16_t aSize )
Chuyển đổi thời lượng uint32_t
(tính bằng giây) thành chuỗi mà con người đọc được.
Bạn cần bật OPENTHREAD_CONFIG_UPTIME_ENABLE
.
Chuỗi tuân theo định dạng "
Nếu chuỗi kết quả không vừa với aBuffer
(trong phạm vi aSize
ký tự), thì chuỗi sẽ bị cắt bớt nhưng chuỗi được trả về sẽ luôn kết thúc rỗng.
Để sử dụng với mAge
hoặc mConnectionTime
trong cấu trúc otNeighborInfo
hoặc otChildInfo
.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
otNetDataContainsOmrPrefix
bool otNetDataContainsOmrPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Kiểm tra xem một Tiền tố nhất định có thể đóng vai trò như một tiền tố OMR hợp lệ hay không, đồng thời Dữ liệu mạng của Nhà lãnh đạo có chứa tiền tố này hay không.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Trả về |
Liệu
aPrefix có phải là tiền tố OMR hợp lệ và Dữ liệu mạng của nhà lãnh đạo có chứa tiền tố OMR aPrefix hay không. |
otNetDataGet
otError otNetDataGet( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength )
Cung cấp bản sao đầy đủ hoặc ổn định cho Dữ liệu mạng luồng của Phân vùng.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otNetDataGetCommissioningDataset
void otNetDataGetCommissioningDataset( otInstance *aInstance, otCommissioningDataset *aDataset )
Nhận Tập dữ liệu được uỷ quyền từ Dữ liệu mạng của phân vùng.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otNetDataGetLength
uint8_t otNetDataGetLength( otInstance *aInstance )
Lấy độ dài hiện tại (số byte) của Dữ liệu mạng chuỗi của Phân vùng.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Độ dài của Dữ liệu mạng.
|
otNetDataGetMaxLength
uint8_t otNetDataGetMaxLength( otInstance *aInstance )
Nhận thời lượng tối đa quan sát được của Dữ liệu mạng luồng kể từ khi khởi chạy ngăn xếp OT (trước) hoặc kể từ lần gọi gần đây nhất đến otNetDataResetMaxLength()
.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Độ dài tối đa của Dữ liệu mạng (mức nước cao cho thời lượng Dữ liệu mạng).
|
otNetDataGetNextLowpanContextInfo
otError otNetDataGetNextLowpanContextInfo( otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo )
Nhận thông tin mã ngữ cảnh 6LoWPAN tiếp theo trong Dữ liệu mạng của phân vùng.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otNetDataGetNextOnMeshPrefix
otError otNetDataGetNextOnMeshPrefix( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig )
Nhận tiền tố lưới tiếp theo trong Dữ liệu mạng của phân vùng.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otNetDataGetNextRoute
otError otNetDataGetNextRoute( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig )
Nhận tuyến bên ngoài tiếp theo trong Dữ liệu mạng của phân vùng.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Giá trị trả về |
|
otNetDataGetNextService
otError otNetDataGetNextService( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig )
Nhận dịch vụ tiếp theo trong Dữ liệu mạng của phân vùng.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Giá trị trả về |
|
otNetDataGetStableVersion
uint8_t otNetDataGetStableVersion( otInstance *aInstance )
Tải phiên bản dữ liệu mạng ổn định.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Phiên bản dữ liệu mạng ổn định.
|
otNetDataGetVersion
uint8_t otNetDataGetVersion( otInstance *aInstance )
Tải phiên bản dữ liệu mạng.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Phiên bản dữ liệu mạng.
|
otNetDataIsDnsSrpServiceAdded
bool otNetDataIsDnsSrpServiceAdded( otInstance *aInstance )
Cho biết liệu mục "Dịch vụ DNS/SRP" hiện có được thêm vào Dữ liệu mạng luồng hay không.
Yêu cầu bật tính năng OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
||||
Giá trị trả về |
|
otNetDataIsPrefixAdded
bool otNetDataIsPrefixAdded( otInstance *aInstance, const otIp6Prefix *aPrefix )
Cho biết liệu mục nhập tiền tố đã phát hành (trên lưới hoặc tuyến bên ngoài) hiện có được thêm vào Dữ liệu mạng luồng hay không.
Yêu cầu bật tính năng OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
||||
Giá trị trả về |
|
otNetDataPublishDnsSrpServiceAnycast
void otNetDataPublishDnsSrpServiceAnycast( otInstance *aInstance, uint8_t aSequenceNUmber )
Yêu cầu xuất bản "Địa chỉ Anycast của dịch vụ DNS/SRP" trong Dữ liệu mạng theo luồng.
Yêu cầu bật tính năng OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Lệnh gọi hàm này sẽ xoá và thay thế mọi mục nhập "Dịch vụ DNS/SRP" trước đó đang được phát hành (từ lệnh gọi trước đó đến bất kỳ hàm otNetDataPublishDnsSrpService{Type}()
nào).
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
otNetDataPublishDnsSrpServiceUnicast
void otNetDataPublishDnsSrpServiceUnicast( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort )
Yêu cầu xuất bản "Địa chỉ Unicast của dịch vụ DNS/SRP" trong Dữ liệu mạng luồng.
Yêu cầu bật tính năng OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Lệnh gọi hàm này sẽ xoá và thay thế mọi mục nhập "Dịch vụ DNS/SRP" trước đó đang được phát hành (từ lệnh gọi trước đó đến bất kỳ hàm otNetDataPublishDnsSrpService{Type}()
nào).
Phát hành "Địa chỉ Unicast Dịch vụ DNS/SRP" bằng cách đưa thông tin địa chỉ và cổng vào dữ liệu TLV của dịch vụ.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid
void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid( otInstance *aInstance, uint16_t aPort )
Yêu cầu xuất bản "Địa chỉ Unicast của dịch vụ DNS/SRP" trong Dữ liệu mạng luồng.
Yêu cầu bật tính năng OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Lệnh gọi hàm này sẽ xoá và thay thế mọi mục nhập "Dịch vụ DNS/SRP" trước đó đang được phát hành (từ lệnh gọi trước đó đến bất kỳ hàm otNetDataPublishDnsSrpService{Type}()
nào).
Không giống như hàm otNetDataPublishDnsSrpServiceUnicast()
yêu cầu cung cấp địa chỉ đã công bố và đưa thông tin vào dữ liệu TLV của dịch vụ, hàm này sử dụng EID cục bộ dạng lưới của thiết bị và đưa thông tin vào dữ liệu TLV của máy chủ.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
otNetDataPublishExternalRoute
otError otNetDataPublishExternalRoute( otInstance *aInstance, const otExternalRouteConfig *aConfig )
Yêu cầu xuất bản tiền tố tuyến bên ngoài trong Dữ liệu mạng luồng.
Yêu cầu bật tính năng OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Bạn chỉ có thể phát hành các mục ổn định (ví dụ:aConfig.mStable
PHẢI là TRUE).
Lệnh gọi tiếp theo đến phương thức này sẽ thay thế yêu cầu trước đó cho cùng tiền tố. Cụ thể, nếu lệnh gọi mới chỉ thay đổi cờ (ví dụ: cấp độ tuỳ chọn) và tiền tố đã được thêm vào Dữ liệu mạng, thì thay đổi đối với cờ sẽ được phản ánh ngay lập tức trong Dữ liệu mạng. Điều này bảo đảm rằng các mục nhập hiện có trong Dữ liệu mạng không bị xoá đột ngột. Lưu ý rằng sự thay đổi về cấp độ tuỳ chọn có khả năng khiến mục nhập bị xoá khỏi Dữ liệu mạng sau khi xác định rằng có các nút khác đang xuất bản cùng một tiền tố có cùng lựa chọn ưu tiên hoặc cao hơn.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Giá trị trả về |
|
otNetDataPublishOnMeshPrefix
otError otNetDataPublishOnMeshPrefix( otInstance *aInstance, const otBorderRouterConfig *aConfig )
Yêu cầu xuất bản một tiền tố trên lưới trong Dữ liệu mạng luồng.
Yêu cầu bật tính năng OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Bạn chỉ có thể phát hành các mục ổn định (ví dụ:aConfig.mStable
PHẢI là TRUE).
Lệnh gọi tiếp theo đến phương thức này sẽ thay thế yêu cầu trước đó cho cùng tiền tố. Cụ thể, nếu lệnh gọi mới chỉ thay đổi cờ (ví dụ: cấp độ tuỳ chọn) và tiền tố đã được thêm vào Dữ liệu mạng, thì thay đổi đối với cờ sẽ được phản ánh ngay lập tức trong Dữ liệu mạng. Điều này bảo đảm rằng các mục nhập hiện có trong Dữ liệu mạng không bị xoá đột ngột. Lưu ý rằng sự thay đổi về cấp độ tuỳ chọn có khả năng khiến mục nhập bị xoá khỏi Dữ liệu mạng sau khi xác định rằng có các nút khác đang xuất bản cùng một tiền tố có cùng lựa chọn ưu tiên hoặc cao hơn.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Giá trị trả về |
|
otNetDataReplacePublishedExternalRoute
otError otNetDataReplacePublishedExternalRoute( otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig )
Thay thế một tuyến bên ngoài đã phát hành trước đó trong Thread Network Data (Dữ liệu mạng luồng).
Yêu cầu bật tính năng OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Nếu không có tuyến bên ngoài nào đã xuất bản trước đó khớp với aPrefix
, thì hàm này sẽ hoạt động tương tự như otNetDataPublishExternalRoute()
, tức là sẽ bắt đầu quá trình xuất bản aConfig dưới dạng một tuyến bên ngoài trong Dữ liệu mạng luồng.
Nếu có một mục nhập tuyến đường đã xuất bản trước đó khớp với aPrefix
, mục nhập đó sẽ được thay thế bằng tiền tố mới từ aConfig
.
- Nếu
aPrefix
đã được thêm vào Dữ liệu mạng, thì việc thay đổi tiền tố mới trongaConfig
sẽ được phản ánh ngay lập tức trong Dữ liệu mạng. Điều này bảo đảm rằng các mục nhập tuyến trong Dữ liệu mạng không bị xoá đột ngột và việc chuyển từ aPrefix sang tiền tố mới diễn ra suôn sẻ. - Nếu
aPrefix
cũ đã phát hành không được thêm vào Dữ liệu mạng thì nó sẽ được thay thế bằng tiền tốaConfig
mới, nhưng sẽ không được thêm ngay lập tức. Thay vào đó, quá trình xuất bản sẽ bắt đầu quá trình xuất bản trong Dữ liệu mạng (theo dõi Dữ liệu mạng để xác định thời điểm/nếu có thêm tiền tố, tuỳ thuộc vào số lượng tiền tố tương tự có trong Dữ liệu mạng).
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otNetDataResetMaxLength
void otNetDataResetMaxLength( otInstance *aInstance )
Đặt lại thời lượng tối đa được theo dõi cho Dữ liệu mạng luồng.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
otNetDataGetMaxLength
otNetDataSetDnsSrpServicePublisherCallback
void otNetDataSetDnsSrpServicePublisherCallback( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext )
Đặt lệnh gọi lại để thông báo khi một "Dịch vụ DNS/SRP" đã phát hành thực sự được thêm vào hoặc bị xoá khỏi Dữ liệu mạng luồng.
Lệnh gọi tiếp theo đến hàm này sẽ thay thế mọi hàm callback đã đặt trước đó.
Yêu cầu bật tính năng OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
otNetDataSetPrefixPublisherCallback
void otNetDataSetPrefixPublisherCallback( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext )
Đặt lệnh gọi lại để thông báo khi một mục nhập tiền tố đã xuất bản thực sự được thêm vào hoặc bị xoá khỏi Dữ liệu mạng luồng.
Lệnh gọi tiếp theo đến hàm này sẽ thay thế mọi hàm callback đã đặt trước đó.
Yêu cầu bật tính năng OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
otNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Kiểm tra xem dữ liệu chỉ đạo có bao gồm Ký tự kết hợp hay không.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otNetDataSteeringDataCheckJoinerWithDiscerner
otError otNetDataSteeringDataCheckJoinerWithDiscerner( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner )
Kiểm tra xem dữ liệu chỉ đạo có bao gồm Trình kết hợp có giá trị rõ ràng nhất định hay không.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otNetDataUnpublishDnsSrpService
void otNetDataUnpublishDnsSrpService( otInstance *aInstance )
Huỷ xuất bản bất kỳ mục nhập Dịch vụ DNS/SRP (Anycast hoặc Unicast) nào đã thêm trước đó từ Thread Network Data.
Bạn phải bật OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
otNetDataUnpublishPrefix
otError otNetDataUnpublishPrefix( otInstance *aInstance, const otIp6Prefix *aPrefix )
Huỷ xuất bản On-Mesh hoặc Tiền tố bên ngoài đã xuất bản trước đó.
Bạn phải bật OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadBecomeChild
otError otThreadBecomeChild( otInstance *aInstance )
Cố gắng đính kèm lại với tư cách là trẻ.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadBecomeDetached
otError otThreadBecomeDetached( otInstance *aInstance )
Tách khỏi mạng Thread.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadDetachGracefully
otError otThreadDetachGracefully( otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext )
Thông báo cho các nút khác trong mạng (nếu có), sau đó dừng hoạt động của giao thức Thread.
Ứng dụng sẽ gửi một Address Release nếu đó là một bộ định tuyến hoặc đặt thời gian chờ của thành phần con thành 0 nếu đó là một thiết bị con.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otThreadDeviceRoleToString
const char * otThreadDeviceRoleToString( otDeviceRole aRole )
Chuyển đổi vai trò của thiết bị thành chuỗi mà con người đọc được.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Một chuỗi đại diện cho
aRole . |
otThreadDiscover
otError otThreadDiscover( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext )
Bắt đầu quét luồng công cụ Khám phá.
Thông tin chi tiết | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Các tham số |
|
||||||||||||||
Giá trị trả về |
|
otThreadGetChildTimeout
uint32_t otThreadGetChildTimeout( otInstance *aInstance )
Lấy Thời gian chờ của chuỗi con (tính bằng giây) được dùng khi thao tác ở vai trò Con.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Giá trị Thời gian chờ của chuỗi con tính bằng giây.
|
otThreadSetChildTimeout
otThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole( otInstance *aInstance )
Nhận vai trò thiết bị.
Thông tin chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Các tham số |
|
||||||||||
Giá trị trả về |
|
otThreadGetDomainName
const char * otThreadGetDomainName( otInstance *aInstance )
Lấy tên miền của luồng.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Con trỏ đến Tên miền luồng.
|
otThreadSetDomainName
otThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId( otInstance *aInstance )
Lấy mã PAN mở rộng theo chuẩn IEEE 802.15.4.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Con trỏ tới mã PAN mở rộng IEEE 802.15.4.
|
otThreadSetExtendedPanId
otThreadGetFixedDuaInterfaceIdentifier
const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier( otInstance *aInstance )
Nhận Giá trị nhận dạng giao diện được chỉ định theo cách thủ công cho Địa chỉ Unicast của miền Thread.
Có sẵn khi bạn bật OPENTHREAD_CONFIG_DUA_ENABLE
.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Con trỏ tới Giá trị nhận dạng giao diện (được đặt theo cách thủ công) hoặc NULL (Rỗng) nếu không được đặt.
|
otThreadSetFixedDuaInterfaceIdentifier
otThreadGetIp6Counters
const otIpCounters * otThreadGetIp6Counters( otInstance *aInstance )
Lấy bộ đếm IPv6.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Con trỏ tới bộ đếm IPv6.
|
otThreadGetKeySequenceCounter
uint32_t otThreadGetKeySequenceCounter( otInstance *aInstance )
Lấy thrKeySequenceCounter.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Giá trị thrKeySequenceCounter.
|
otThreadSetKeySequenceCounter
otThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime( otInstance *aInstance )
Nhận thrKeySwitchGuardTime (theo giờ).
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Giá trị thrKeySwitchGuardTime (theo giờ).
|
otThreadSetKeySwitchGuardTime
otThreadGetLeaderData
otError otThreadGetLeaderData( otInstance *aInstance, otLeaderData *aLeaderData )
Nhận dữ liệu về người lãnh đạo chuỗi.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
||||
Giá trị trả về |
|
otThreadGetLeaderRloc
otError otThreadGetLeaderRloc( otInstance *aInstance, otIp6Address *aLeaderRloc )
Trả về một con trỏ đến RLOC của Người lãnh đạo.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otThreadGetLeaderRouterId
uint8_t otThreadGetLeaderRouterId( otInstance *aInstance )
Lấy mã bộ định tuyến của người lãnh đạo.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Mã bộ định tuyến của người lãnh đạo.
|
otThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight( otInstance *aInstance )
Xem trọng lực của người lãnh đạo.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Trọng lượng của người lãnh đạo.
|
otThreadGetLinkLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Lấy địa chỉ phát đa hướng của Thread Link-Local All Thread Nodes.
Địa chỉ là Địa chỉ phát đa hướng dựa trên tiền tố Unicast liên kết cục bộ [RFC 3306], với:
- flgs được đặt thành 3 (P = 1 và T = 1)
- đặt cố định ở mức 2
- ống kính được đặt ở mức 64
- tiền tố mạng được đặt thành Tiền tố cục bộ lưới
- đã đặt mã nhóm thành 1
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Con trỏ đến địa chỉ phát đa hướng của Thread Link-Local All Thread Nodes.
|
otThreadGetLinkLocalIp6Address
const otIp6Address * otThreadGetLinkLocalIp6Address( otInstance *aInstance )
Lấy địa chỉ IPv6 cục bộ của Thread.
Địa chỉ cục bộ của đường liên kết Thread được lấy từ địa chỉ Extended Address làm mã nhận dạng giao diện theo chuẩn IEEE802.15.4.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Con trỏ đến địa chỉ IPv6 liên kết cục bộ của Thread.
|
otThreadGetLinkMode
otLinkModeConfig otThreadGetLinkMode( otInstance *aInstance )
Tải cấu hình Chế độ liên kết MLE.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Cấu hình Chế độ liên kết MLE.
|
otThreadSetLinkMode
otThreadGetMaxTimeInQueue
uint32_t otThreadGetMaxTimeInQueue( otInstance *aInstance )
Nhận thời gian trong hàng đợi tối đa của các thư trong hàng đợi TX.
Cần có OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE
.
Thời gian trong hàng đợi chỉ được theo dõi đối với quá trình truyền trực tiếp và được đo lường bằng khoảng thời gian từ khi một thông báo được thêm vào hàng đợi truyền cho đến khi thông báo được chuyển đến lớp MAC để truyền tải hoặc bị loại bỏ.
Bạn có thể đặt lại số liệu thống kê đã thu thập bằng cách gọi otThreadResetTimeInQueueStat()
.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Thời gian trong hàng đợi tối đa tính bằng mili giây cho tất cả thông báo trong hàng đợi TX (cho đến thời điểm này).
|
otThreadGetMeshLocalEid
const otIp6Address * otThreadGetMeshLocalEid( otInstance *aInstance )
Lấy địa chỉ EID cục bộ Mesh.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Con trỏ đến địa chỉ EID cục bộ của lưới (Mesh Local EID).
|
otThreadGetMeshLocalPrefix
const otMeshLocalPrefix * otThreadGetMeshLocalPrefix( otInstance *aInstance )
Trả về một con trỏ cho Tiền tố cục bộ dạng lưới (Mesh Local Prefix).
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Con trỏ đến Tiền tố cục bộ dạng lưới (Mesh Local Prefix).
|
otThreadGetMleCounters
const otMleCounters * otThreadGetMleCounters( otInstance *aInstance )
Lấy bộ đếm Thread MLE.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Con trỏ đến bộ đếm Thread MLE.
|
otThreadGetNetworkKey
void otThreadGetNetworkKey( otInstance *aInstance, otNetworkKey *aNetworkKey )
Lấy khoá mạng luồng.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadSetNetworkKey
otThreadGetNetworkKeyRef
otNetworkKeyRef otThreadGetNetworkKeyRef( otInstance *aInstance )
Tải otNetworkKeyRef
cho Khoá mạng luồng.
Yêu cầu bật tính năng thời gian xây dựng OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Tham chiếu đến Khoá mạng luồng được lưu trữ trong bộ nhớ.
|
otThreadSetNetworkKeyRef
otThreadGetNetworkName
const char * otThreadGetNetworkName( otInstance *aInstance )
Lấy tên mạng luồng.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Con trỏ đến Tên mạng luồng.
|
otThreadSetNetworkName
otThreadGetNextDiagnosticTlv
otError otThreadGetNextDiagnosticTlv( const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv )
Nhận được TLV Network Chẩn đoán mạng tiếp theo trong thông báo.
Cần có OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
.
Lệnh gọi tiếp theo đến hàm này chỉ được phép khi giá trị trả về hiện tại là OT_ERROR_NONE.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otThreadGetNextNeighborInfo
otError otThreadGetNextNeighborInfo( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo )
Nhận thông tin về người lân cận tiếp theo.
Hàm này được dùng để đi qua các mục nhập của bảng lân cận.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otThreadGetParentAverageRssi
otError otThreadGetParentAverageRssi( otInstance *aInstance, int8_t *aParentRssi )
Hàm này truy xuất RSSI trung bình cho Thread Parent.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetParentInfo
otError otThreadGetParentInfo( otInstance *aInstance, otRouterInfo *aParentInfo )
Hàm này truy xuất thông tin chẩn đoán cho Bộ định tuyến luồng dưới dạng thành phần mẹ.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetParentLastRssi
otError otThreadGetParentLastRssi( otInstance *aInstance, int8_t *aLastRssi )
Hàm này truy xuất RSSI của gói cuối cùng từ Thread Parent.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otThreadGetPartitionId
uint32_t otThreadGetPartitionId( otInstance *aInstance )
Lấy mã phân vùng.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Mã phân vùng.
|
otThreadGetRealmLocalAllThreadNodesMulticastAddress
const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress( otInstance *aInstance )
Lấy địa chỉ phát đa hướng của Thread Realm-Local All Thread Nodes.
Địa chỉ là Địa chỉ Multicast dựa trên tiền tố Unicast cục bộ [RFC 3306], với:
- flgs được đặt thành 3 (P = 1 và T = 1)
- scop được đặt thành 3
- ống kính được đặt ở mức 64
- tiền tố mạng được đặt thành Tiền tố cục bộ lưới
- đã đặt mã nhóm thành 1
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Con trỏ đến địa chỉ phát đa hướng của Thread Realm-Local All Thread Nodes.
|
otThreadGetRloc
const otIp6Address * otThreadGetRloc( otInstance *aInstance )
Lấy địa chỉ Bộ định tuyến luồng (RLOC).
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Con trỏ đến địa chỉ Bộ định tuyến luồng (RLOC).
|
otThreadGetRloc16
uint16_t otThreadGetRloc16( otInstance *aInstance )
Tải RLOC16.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
RLOC16.
|
otThreadGetServiceAloc
otError otThreadGetServiceAloc( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc )
Truy xuất ALOC của dịch vụ cho Mã dịch vụ đã cho.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Giá trị trả về |
|
otThreadGetTimeInQueueHistogram
const uint32_t * otThreadGetTimeInQueueHistogram( otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval )
Lấy biểu đồ thời gian trong hàng đợi cho các thư trong hàng đợi TX.
Cần có OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE
.
Biểu đồ thời gian trong hàng đợi của các thông báo trong hàng đợi truyền sẽ được thu thập. Thời gian trong hàng đợi chỉ được theo dõi đối với quá trình truyền trực tiếp và được đo lường bằng khoảng thời gian từ khi một thông báo được thêm vào hàng đợi truyền cho đến khi thông báo được chuyển đến lớp MAC để truyền tải hoặc bị loại bỏ.
Biểu đồ được trả về dưới dạng một mảng các giá trị uint32_t
với các mục nhập aNumBins
. Mục đầu tiên trong mảng (tại chỉ mục 0) thể hiện số lượng tin nhắn có thời gian trong hàng đợi nhỏ hơn aBinInterval
. Mục nhập thứ hai thể hiện số lượng thư có thời gian trong hàng đợi lớn hơn hoặc bằng aBinInterval
, nhưng nhỏ hơn 2 * aBinInterval
. Và nhiều mục tiêu khác. Mục nhập cuối cùng thể hiện số lượng thư có thời gian trong hàng đợi lớn hơn hoặc bằng (aNumBins - 1) * aBinInterval
.
Bạn có thể đặt lại số liệu thống kê đã thu thập bằng cách gọi otThreadResetTimeInQueueStat()
. Thông tin biểu đồ được thu thập kể từ khi thực thể OpenThread được khởi chạy hoặc kể từ lần gần nhất hoạt động thu thập số liệu thống kê được đặt lại bằng cách gọi otThreadResetTimeInQueueStat()
.
Con trỏ aNumBins
và aBinInterval
KHÔNG ĐƯỢC là NULL.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
||||||
Trả về |
Con trỏ đến một mảng các mục
aNumBins đại diện cho thông tin biểu đồ đã thu thập. |
otThreadGetVendorModel
const char * otThreadGetVendorModel( otInstance *aInstance )
Lấy chuỗi mô hình của nhà cung cấp.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Chuỗi mô hình của nhà cung cấp.
|
otThreadGetVendorName
const char * otThreadGetVendorName( otInstance *aInstance )
Lấy chuỗi tên nhà cung cấp.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Chuỗi tên nhà cung cấp.
|
otThreadGetVendorSwVersion
const char * otThreadGetVendorSwVersion( otInstance *aInstance )
Lấy chuỗi phiên bản sw của nhà cung cấp.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
Chuỗi phiên bản sw của nhà cung cấp.
|
otThreadGetVersion
uint16_t otThreadGetVersion( void )
Lấy phiên bản giao thức Thread.
Thông tin chi tiết | |
---|---|
Trả về |
phiên bản giao thức Thread.
|
otThreadIsAnycastLocateInProgress
bool otThreadIsAnycastLocateInProgress( otInstance *aInstance )
Cho biết liệu yêu cầu định vị Anycast có đang được xử lý hay không.
Chỉ dùng được khi bạn bật OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
||
Trả về |
TRUE nếu một yêu cầu định vị Anycast đang diễn ra, nếu không thì là FALSE.
|
otThreadIsDiscoverInProgress
bool otThreadIsDiscoverInProgress( otInstance *aInstance )
Xác định xem quá trình Khám phá luồng MLE có đang diễn ra hay không.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
otThreadIsSingleton
bool otThreadIsSingleton( otInstance *aInstance )
Cho biết liệu một nút có phải là bộ định tuyến duy nhất trên mạng hay không.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadLocateAnycastDestination
otError otThreadLocateAnycastDestination( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext )
Yêu cầu định vị đích đến gần nhất của một địa chỉ Anycast đã cho.
Chỉ dùng được khi bạn bật OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE
.
Nếu yêu cầu trước đó đang tiếp diễn, thì lệnh gọi tiếp theo tới hàm này sẽ huỷ và thay thế yêu cầu trước đó.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otThreadRegisterParentResponseCallback
void otThreadRegisterParentResponseCallback( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext )
Đăng ký lệnh gọi lại để nhận dữ liệu Phản hồi của cha mẹ MLE.
Cần có OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE
.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
otThreadResetIp6Counters
void otThreadResetIp6Counters( otInstance *aInstance )
Đặt lại bộ đếm IPv6.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
otThreadResetMleCounters
void otThreadResetMleCounters( otInstance *aInstance )
Đặt lại bộ đếm Thread MLE.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
otThreadResetTimeInQueueStat
void otThreadResetTimeInQueueStat( otInstance *aInstance )
Đặt lại số liệu thống kê về thời gian trong hàng đợi của hàng đợi TX.
Cần có OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE
.
Thông tin chi tiết | |||
---|---|---|---|
Thông số |
|
otThreadSearchForBetterParent
otError otThreadSearchForBetterParent( otInstance *aInstance )
Bắt đầu quá trình để trẻ tìm kiếm cha mẹ tốt hơn trong khi vẫn tiếp tục gắn bó với cha mẹ hiện tại.
Phải sử dụng khi thiết bị được gắn với tư cách là trẻ.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Giá trị trả về |
|
otThreadSendAddressNotification
void otThreadSendAddressNotification( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid )
Gửi thư Thông báo địa chỉ chủ động ( {6/}_NTF.ntf).
Chỉ dùng được khi bạn bật OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
otThreadSendDiagnosticGet
otError otThreadSendDiagnosticGet( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext )
Gửi yêu cầu Nhận chẩn đoán mạng.
Cần có OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
.
Thông tin chi tiết | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||||||
Giá trị trả về |
|
otThreadSendDiagnosticReset
otError otThreadSendDiagnosticReset( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount )
Gửi yêu cầu Đặt lại chẩn đoán mạng.
Cần có OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otThreadSendProactiveBackboneNotification
otError otThreadSendProactiveBackboneNotification( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction )
Gửi thông báo Chủ động thông báo về trục chính (PRO_BB.ntf) trên đường liên kết Backbone.
Chỉ dùng được khi bạn bật OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otThreadSetChildTimeout
void otThreadSetChildTimeout( otInstance *aInstance, uint32_t aTimeout )
Đặt Thời gian chờ của chuỗi con (tính bằng giây) được dùng khi hoạt động ở vai trò Con.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetChildTimeout
otThreadSetDiscoveryRequestCallback
void otThreadSetDiscoveryRequestCallback( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext )
Đặt lệnh gọi lại để nhận dữ liệu Yêu cầu khám phá MLE.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
|
otThreadSetDomainName
otError otThreadSetDomainName( otInstance *aInstance, const char *aDomainName )
Đặt tên miền của luồng.
Chỉ thành công khi tắt giao thức Thread.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetDomainName
otThreadSetEnabled
otError otThreadSetEnabled( otInstance *aInstance, bool aEnabled )
Bắt đầu hoạt động đối với giao thức Thread.
Giao diện phải bật khi gọi hàm này.
Việc gọi hàm này với aEnabled
được đặt thành FALSE sẽ dừng mọi quá trình tách rời đang diễn ra do otThreadDetachGracefully() bắt đầu. Lệnh gọi lại của hàm này sẽ được gọi.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadSetExtendedPanId
otError otThreadSetExtendedPanId( otInstance *aInstance, const otExtendedPanId *aExtendedPanId )
Đặt Mã PAN mở rộng theo chuẩn IEEE 802.15.4.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetExtendedPanId
otThreadSetFixedDuaInterfaceIdentifier
otError otThreadSetFixedDuaInterfaceIdentifier( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid )
Đặt hoặc xoá Giá trị nhận dạng giao diện được chỉ định theo cách thủ công cho Địa chỉ Unicast của miền luồng.
Có sẵn khi bạn bật OPENTHREAD_CONFIG_DUA_ENABLE
.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetFixedDuaInterfaceIdentifier
otThreadSetJoinerAdvertisement
otError otThreadSetJoinerAdvertisement( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength )
Đặt Thread Joiner Quảng cáo khi khám phá mạng Thread.
Quảng cáo kết hợp chuỗi được sử dụng để cho phép Người tham gia quảng cáo thông tin cụ thể về ứng dụng của mình (chẳng hạn như ID nhà cung cấp, ID sản phẩm, Người phân biệt, v.v.) qua TLV Quảng cáo cho Người tham gia mới được đề xuất và để cung cấp thông tin này cho các Ủy viên hoặc Ứng viên Ủy viên mà không cần sự tương tác trực tiếp của con người.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
||||||||
Giá trị trả về |
|
otThreadSetKeySequenceCounter
void otThreadSetKeySequenceCounter( otInstance *aInstance, uint32_t aKeySequenceCounter )
Đặt thrKeySequenceCounter.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetKeySequenceCounter
otThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime( otInstance *aInstance, uint32_t aKeySwitchGuardTime )
Đặt thrKeySwitchGuardTime (theo giờ).
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
otThreadGetKeySwitchGuardTime
otThreadSetLinkMode
otError otThreadSetLinkMode( otInstance *aInstance, otLinkModeConfig aConfig )
Đặt cấu hình Chế độ liên kết MLE.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetLinkMode
otThreadSetMeshLocalPrefix
otError otThreadSetMeshLocalPrefix( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix )
Đặt Tiền tố cục bộ Mesh.
Chỉ thành công khi giao thức Thread bị tắt. Lệnh gọi thành công hàm này sẽ làm mất hiệu lực của Tập dữ liệu hoạt động đang hoạt động và đang chờ xử lý trong bộ nhớ bất biến.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadSetNetworkKey
otError otThreadSetNetworkKey( otInstance *aInstance, const otNetworkKey *aKey )
Đặt khoá mạng luồng.
Chỉ thành công khi giao thức Thread bị tắt. Lệnh gọi thành công hàm này sẽ làm mất hiệu lực của Tập dữ liệu hoạt động đang hoạt động và đang chờ xử lý trong bộ nhớ bất biến.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetNetworkKey
otThreadSetNetworkKeyRef
otError otThreadSetNetworkKeyRef( otInstance *aInstance, otNetworkKeyRef aKeyRef )
Đặt Khoá mạng luồng làm otNetworkKeyRef
.
Chỉ thành công khi giao thức Thread bị tắt. Lệnh gọi thành công hàm này sẽ làm mất hiệu lực của Tập dữ liệu hoạt động đang hoạt động và đang chờ xử lý trong bộ nhớ bất biến.
Yêu cầu bật tính năng thời gian xây dựng OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetNetworkKeyRef
otThreadSetNetworkName
otError otThreadSetNetworkName( otInstance *aInstance, const char *aNetworkName )
Đặt tên mạng chuỗi.
Chỉ thành công khi giao thức Thread bị tắt. Lệnh gọi thành công hàm này sẽ làm mất hiệu lực của Tập dữ liệu hoạt động đang hoạt động và đang chờ xử lý trong bộ nhớ bất biến.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadGetNetworkName
otThreadSetVendorModel
otError otThreadSetVendorModel( otInstance *aInstance, const char *aVendorModel )
Đặt chuỗi mô hình nhà cung cấp.
Cần có OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE
.
aVendorModel
phải là UTF8 với độ dài tối đa là 32 ký tự (MAX_VENDOR_MODEL_TLV_LENGTH
). Độ dài tối đa không bao gồm ký tự \0
rỗng.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadSetVendorName
otError otThreadSetVendorName( otInstance *aInstance, const char *aVendorName )
Đặt chuỗi tên nhà cung cấp.
Cần có OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE
.
aVendorName
phải là UTF8 với độ dài tối đa là 32 ký tự (MAX_VENDOR_NAME_TLV_LENGTH
). Độ dài tối đa không bao gồm ký tự \0
rỗng.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
otThreadSetVendorSwVersion
otError otThreadSetVendorSwVersion( otInstance *aInstance, const char *aVendorSwVersion )
Đặt chuỗi phiên bản phần mềm của nhà cung cấp.
Cần có OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE
.
aVendorSwVersion
phải là UTF8 với độ dài tối đa là 16 ký tự(MAX_VENDOR_SW_VERSION_TLV_LENGTH
). Độ dài tối đa không bao gồm ký tự \0
rỗng.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Thông số |
|
||||
Giá trị trả về |
|
Macro
OT_DURATION_STRING_SIZE
OT_DURATION_STRING_SIZE 21
Kích thước đề xuất cho chuỗi biểu thị thời lượng uint32_t
tính bằng giây.
OT_JOINER_ADVDATA_MAX_LENGTH
OT_JOINER_ADVDATA_MAX_LENGTH 64
Độ dài AdvData tối đa của Quảng cáo kết hợp.
OT_NEIGHBOR_INFO_ITERATOR_INIT
OT_NEIGHBOR_INFO_ITERATOR_INIT 0
Trình khởi tạo cho otNeighborInfoIterator.
OT_NETWORK_BASE_TLV_MAX_LENGTH
OT_NETWORK_BASE_TLV_MAX_LENGTH 254
Độ dài giá trị tối đa của TLV cơ sở luồng.
OT_NETWORK_DATA_ITERATOR_INIT
OT_NETWORK_DATA_ITERATOR_INIT 0
Giá trị để khởi chạy otNetworkDataIterator
.
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE
OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3
Kích thước của mục nhập Bảng con chẩn đoán mạng.
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0
Trình khởi tạo cho otNetworkDiagIterator.
OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64
Độ dài tối đa của TLV phiên bản ngăn xếp luồng.
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32
Độ dài tối đa của TLV mô hình nhà cung cấp.
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32
Độ dài tối đa của TLV tên nhà cung cấp.
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16
Độ dài tối đa của bản TLV phiên bản SW của nhà cung cấp.
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES
OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19
Số loại TLV chẩn đoán mạng tối đa cần yêu cầu hoặc đặt lại.
OT_NETWORK_MAX_ROUTER_ID
OT_NETWORK_MAX_ROUTER_ID 62
Mã bộ định tuyến tối đa.
OT_SERVER_DATA_MAX_SIZE
OT_SERVER_DATA_MAX_SIZE 248
Kích thước tối đa của Dữ liệu máy chủ tính bằng byte. Giới hạn lý thuyết, thực tế thấp hơn nhiều.
OT_SERVICE_DATA_MAX_SIZE
OT_SERVICE_DATA_MAX_SIZE 252
Kích thước tối đa của Dữ liệu dịch vụ tính bằng byte.
Tài nguyên
Các chủ đề tham khảo API OpenThread bắt nguồn từ mã nguồn, có trên GitHub. Để biết thêm thông tin hoặc để đóng góp cho tài liệu của chúng tôi, hãy tham khảo Tài nguyên.