Trình theo dõi lịch sử
Ghi lại nhật ký các sự kiện khác nhau, chẳng hạn như thông báo RX và TX hoặc các thay đổi thông tin mạng.
Tóm tắt
Tất cả các mục được theo dõi đều có dấu thời gian.
Các hàm trong mô-đun này có sẵn khi bật OPENTHREAD_CONFIG_HISTOR_TRACKER_ENABLE
.
Typedef |
|
---|---|
otHistoryTrackerExternalRouteInfo
|
typedef Cấu trúc này đại diện cho thông tin tuyến đường bên ngoài Dữ liệu mạng. |
otHistoryTrackerIterator
|
typedefstruct otHistoryTrackerIterator
Loại này đại diện cho một đối tượng iterator trong vòng lặp qua một danh sách lịch sử. |
otHistoryTrackerMessageInfo
|
typedefstruct otHistoryTrackerMessageInfo
Cấu trúc này đại diện cho thông tin thông báo RX/TX IPv6. |
otHistoryTrackerMulticastAddressInfo
|
typedef Cấu trúc này đại diện cho thông tin địa chỉ đa hướng IPv6. |
otHistoryTrackerNeighborInfo
|
typedefstruct otHistoryTrackerNeighborInfo
Cấu trúc này đại diện cho một thông tin lân cận. |
otHistoryTrackerNetworkInfo
|
typedefstruct otHistoryTrackerNetworkInfo
Cấu trúc này đại diện cho thông tin trên mạng Chuỗi. |
otHistoryTrackerOnMeshPrefixInfo
|
typedef Cấu trúc này đại diện cho Dữ liệu mạng trên thông tin về tiền tố lưới. |
otHistoryTrackerRouterInfo
|
typedefstruct otHistoryTrackerRouterInfo
Cấu trúc này đại diện cho một sự kiện nhập vào bảng bộ định tuyến. |
otHistoryTrackerUnicastAddressInfo
|
typedef Cấu trúc này đại diện cho thông tin địa chỉ IPv6 unicast. |
Hàm |
|
---|---|
otHistoryTrackerEntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
|
void
Hàm này chuyển đổi một độ tuổi truy cập nhất định thành một chuỗi dễ đọc.
|
otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator)
|
void
Hàm này khởi tạo một
otHistoryTrackerIterator . |
otHistoryTrackerIterateExternalRouteHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
Hàm này lặp lại các mục nhập trong danh sách mục nhập tuyến đường bên ngoài của Dữ liệu mạng.
|
otHistoryTrackerIterateMulticastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
Hàm này lặp lại các mục nhập trong danh sách lịch sử địa chỉ phát đa hướng.
|
otHistoryTrackerIterateNeighborHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerNeighborInfo *
Hàm này lặp lại trên các mục nhập trong danh sách lịch sử lân cận.
|
otHistoryTrackerIterateNetInfoHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerNetworkInfo *
Hàm này lặp lại các mục nhập trong danh sách lịch sử thông tin mạng.
|
otHistoryTrackerIterateOnMeshPrefixHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerOnMeshPrefixInfo *
Hàm này lặp lại các mục nhập trong Dữ liệu mạng trên danh sách lịch sử mục nhập tiền tố lưới.
|
otHistoryTrackerIterateRouterHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerRouterInfo *
Hàm này lặp lại các mục nhập trong danh sách lịch sử bộ định tuyến.
|
otHistoryTrackerIterateRxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerMessageInfo *
Hàm này lặp lại các mục nhập trong danh sách nhật ký thông báo RX.
|
otHistoryTrackerIterateTxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerMessageInfo *
Hàm này lặp lại các mục nhập trong danh sách lịch sử thông báo TX.
|
otHistoryTrackerIterateUnicastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
Hàm này lặp lại các mục nhập trong danh sách lịch sử địa chỉ unicast.
|
Cấu trúc |
|
---|---|
otHistoryTrackerExternalRouteInfo |
Cấu trúc này đại diện cho thông tin tuyến đường bên ngoài Dữ liệu mạng. |
otHistoryTrackerIterator |
Loại này đại diện cho một đối tượng iterator trong vòng lặp qua một danh sách lịch sử. |
otHistoryTrackerMessageInfo |
Cấu trúc này đại diện cho thông tin thông báo RX/TX IPv6. |
otHistoryTrackerMulticastAddressInfo |
Cấu trúc này đại diện cho thông tin địa chỉ đa hướng IPv6. |
otHistoryTrackerNeighborInfo |
Cấu trúc này đại diện cho một thông tin lân cận. |
otHistoryTrackerNetworkInfo |
Cấu trúc này đại diện cho thông tin trên mạng Chuỗi. |
otHistoryTrackerOnMeshPrefixInfo |
Cấu trúc này đại diện cho Dữ liệu mạng trên thông tin về tiền tố lưới. |
otHistoryTrackerRouterInfo |
Cấu trúc này đại diện cho một sự kiện nhập vào bảng bộ định tuyến. |
otHistoryTrackerUnicastAddressInfo |
Cấu trúc này đại diện cho thông tin địa chỉ IPv6 unicast. |
Bảng liệt kê
enum ẩn danh
anonymous enum
Các hằng số đại diện cho mức độ ưu tiên của thông báo được sử dụng trong cấu trúc otHistoryTrackerMessageInfo
.
Thuộc tính | |
---|---|
OT_HISTORY_TRACKER_MSG_PRIORITY_HIGH
|
Mức độ ưu tiên cao. |
OT_HISTORY_TRACKER_MSG_PRIORITY_LOW
|
Mức độ ưu tiên thấp. |
OT_HISTORY_TRACKER_MSG_PRIORITY_NET
|
Mức độ ưu tiên của quyền kiểm soát mạng. |
OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL
|
Mức độ ưu tiên thông thường. |
otHistoryTrackerAddressEvent
otHistoryTrackerAddressEvent
Bảng liệt kê này xác định các sự kiện cho thông tin địa chỉ IPv6 (unicast hoặc multicast) (tức là liệu địa chỉ được thêm hay bị xoá).
Thuộc tính | |
---|---|
OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED
|
Đã thêm địa chỉ. |
OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED
|
Đã xoá địa chỉ. |
otHistoryTrackerNeighborEvent
otHistoryTrackerNeighborEvent
Bảng liệt kê này xác định các sự kiện trong một thông tin lân cận (tức là
liệu người hàng xóm có được thêm, xóa hoặc thay đổi không).
Sự kiện OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING
chỉ áp dụng cho những người con là trẻ em. Kích hoạt này được kích hoạt sau khi thiết bị khởi động lại và khi danh sách con trước đó được truy xuất từ cài đặt không thay đổi và thiết bị cố gắng khôi phục kết nối với chúng.
Thuộc tính | |
---|---|
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED
|
Lân cận đã được thêm. |
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED
|
Vùng lân cận đã thay đổi (ví dụ: cờ của chế độ thiết bị đã thay đổi). |
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED
|
Vùng lân cận đã bị xóa. |
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING
|
Vùng lân cận đang được khôi phục (chỉ áp dụng cho trẻ em). |
otHistoryTrackerNetDataEvent
otHistoryTrackerNetDataEvent
Bảng liệt kê này xác định các sự kiện cho một mục nhập Dữ liệu mạng (tức là liệu một mục nhập được thêm hay xóa).
Thuộc tính | |
---|---|
OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED
|
Đã thêm mục nhập dữ liệu mạng. |
OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED
|
Đã xoá mục dữ liệu mạng. |
otHistoryTrackerRouterEvent
otHistoryTrackerRouterEvent
Bảng liệt kê này xác định các sự kiện trong thông tin bộ định tuyến (chẳng hạn như
liệu bộ định tuyến được thêm, xoá hay thay đổi).
Thuộc tính | |
---|---|
OT_HISTORY_TRACKER_ROUTER_EVENT_ADDED
|
Đã thêm bộ định tuyến (đã phân bổ mã nhận dạng bộ định tuyến). |
OT_HISTORY_TRACKER_ROUTER_EVENT_COST_CHANGED
|
Đã thay đổi chi phí của đường dẫn nhập bộ định tuyến (bước tiếp theo như trước đây). |
OT_HISTORY_TRACKER_ROUTER_EVENT_NEXT_HOP_CHANGED
|
Bước tiếp theo của bộ định tuyến và chi phí đã thay đổi. |
OT_HISTORY_TRACKER_ROUTER_EVENT_REMOVED
|
Đã xoá mục bộ định tuyến (đã huỷ mã bộ định tuyến). |
Typedef
otHistoryTrackerExternalRouteInfo
struct otHistoryTrackerExternalRouteInfo otHistoryTrackerExternalRouteInfo
Cấu trúc này đại diện cho thông tin tuyến đường bên ngoài Dữ liệu mạng.
otHistoryTrackerIterator
struct otHistoryTrackerIterator otHistoryTrackerIterator
Loại này đại diện cho một đối tượng iterator trong vòng lặp qua một danh sách lịch sử.
Các trường trong loại này không trong suốt (dành cho lõi OpenThread) và do đó người gọi không thể truy cập/sử dụng các trường này.
Trước khi sử dụng biến lặp, bạn PHẢI khởi chạy hàm này bằng otHistoryTrackerInitIterator()
,
otHistoryTrackerMessageInfo
struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo
Cấu trúc này đại diện cho thông tin thông báo RX/TX IPv6.
Một số trường trong cấu trúc này chỉ áp dụng cho thông báo RX hoặc thông báo TX, ví dụ: mAveRxRss
là RSS trung bình của tất cả khung mảnh tạo thành thông báo nhận được và chỉ áp dụng cho thông báo RX.
otHistoryTrackerMulticastAddressInfo
struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo
Cấu trúc này đại diện cho thông tin địa chỉ đa hướng IPv6.
otHistoryTrackerNeighborInfo
struct otHistoryTrackerNeighborInfo otHistoryTrackerNeighborInfo
Cấu trúc này đại diện cho một thông tin lân cận.
otHistoryTrackerNetworkInfo
struct otHistoryTrackerNetworkInfo otHistoryTrackerNetworkInfo
Cấu trúc này đại diện cho thông tin trên mạng Chuỗi.
otHistoryTrackerOnMeshPrefixInfo
struct otHistoryTrackerOnMeshPrefixInfo otHistoryTrackerOnMeshPrefixInfo
Cấu trúc này đại diện cho Dữ liệu mạng trên thông tin về tiền tố lưới.
otHistoryTrackerRouterInfo
struct otHistoryTrackerRouterInfo otHistoryTrackerRouterInfo
Cấu trúc này đại diện cho một sự kiện nhập vào bảng bộ định tuyến.
otHistoryTrackerUnicastAddressInfo
struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo
Cấu trúc này đại diện cho thông tin địa chỉ IPv6 unicast.
Hàm
otHistoryTrackerEntryAgeToString
void otHistoryTrackerEntryAgeToString( uint32_t aEntryAge, char *aBuffer, uint16_t aSize )
Hàm này chuyển đổi một độ tuổi truy cập nhất định thành một chuỗi dễ đọc.
Chuỗi độ tuổi nhập theo định dạng "
Nếu chuỗi kết quả không vừa với aBuffer
(trong các ký tự aSize
), chuỗi sẽ bị cắt bớt nhưng chuỗi được xuất luôn kết thúc bằng rỗng.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
otHistoryTrackerInitIterator
void otHistoryTrackerInitIterator( otHistoryTrackerIterator *aIterator )
Hàm này khởi tạo một otHistoryTrackerIterator
.
Bạn phải khởi tạo biến lặp trước khi sử dụng.
Bạn có thể khởi động lại biến lặp từ đầu danh sách.
Khi lặp lại các mục nhập trong một danh sách, để đảm bảo rằng mục nhập của mục nhập nhất quán, độ tuổi tương ứng được cung cấp tương ứng với thời gian thực hiện trình lặp, tức là tuổi mục được cung cấp dưới dạng thời lượng (tính bằng mili giây) từ sự kiện (khi mục nhập được ghi lại) đến thời gian khởi tạo vòng lặp.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
otHistoryTrackerIterateExternalRouteHistory
const otHistoryTrackerExternalRouteInfo * otHistoryTrackerIterateExternalRouteHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Hàm này lặp lại các mục nhập trong danh sách mục nhập tuyến đường bên ngoài của Dữ liệu mạng.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Trả về |
Mục nhập
otHistoryTrackerExternalRouteInfo hoặc NULL nếu không có mục nhập nào khác trong danh sách. |
otHistoryTrackerIterateMulticastAddressHistory
const otHistoryTrackerMulticastAddressInfo * otHistoryTrackerIterateMulticastAddressHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Hàm này lặp lại các mục nhập trong danh sách lịch sử địa chỉ phát đa hướng.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Trả về |
Con trỏ trỏ đến mục
otHistoryTrackerMulticastAddressInfo hoặc NULL nếu không có mục nào khác trong danh sách. |
otHistoryTrackerIterateNeighborHistory
const otHistoryTrackerNeighborInfo * otHistoryTrackerIterateNeighborHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Hàm này lặp lại trên các mục nhập trong danh sách lịch sử lân cận.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Trả về |
Mục nhập
otHistoryTrackerNeighborInfo hoặc NULL nếu không có mục nhập nào khác trong danh sách. |
otHistoryTrackerIterateNetInfoHistory
const otHistoryTrackerNetworkInfo * otHistoryTrackerIterateNetInfoHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Hàm này lặp lại các mục nhập trong danh sách lịch sử thông tin mạng.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Trả về |
Con trỏ trỏ đến mục
otHistoryTrackerNetworkInfo hoặc NULL nếu không có mục nào khác trong danh sách. |
otHistoryTrackerIterateOnMeshPrefixHistory
const otHistoryTrackerOnMeshPrefixInfo * otHistoryTrackerIterateOnMeshPrefixHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Hàm này lặp lại các mục nhập trong Dữ liệu mạng trên danh sách lịch sử mục nhập tiền tố lưới.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Trả về |
Mục nhập
otHistoryTrackerOnMeshPrefixInfo hoặc NULL nếu không có mục nhập nào khác trong danh sách. |
otHistoryTrackerIterateRouterHistory
const otHistoryTrackerRouterInfo * otHistoryTrackerIterateRouterHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Hàm này lặp lại các mục nhập trong danh sách lịch sử bộ định tuyến.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Trả về |
Mục nhập
otHistoryTrackerRouterInfo hoặc NULL nếu không có mục nhập nào khác trong danh sách. |
otHistoryTrackerIterateRxHistory
const otHistoryTrackerMessageInfo * otHistoryTrackerIterateRxHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Hàm này lặp lại các mục nhập trong danh sách nhật ký thông báo RX.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Trả về |
Mục nhập
otHistoryTrackerMessageInfo hoặc NULL nếu không có mục nhập nào khác trong danh sách. |
otHistoryTrackerIterateTxHistory
const otHistoryTrackerMessageInfo * otHistoryTrackerIterateTxHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Hàm này lặp lại các mục nhập trong danh sách lịch sử thông báo TX.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Trả về |
Mục nhập
otHistoryTrackerMessageInfo hoặc NULL nếu không có mục nhập nào khác trong danh sách. |
otHistoryTrackerIterateUnicastAddressHistory
const otHistoryTrackerUnicastAddressInfo * otHistoryTrackerIterateUnicastAddressHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Hàm này lặp lại các mục nhập trong danh sách lịch sử địa chỉ unicast.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Trả về |
Con trỏ trỏ đến mục
otHistoryTrackerUnicastAddressInfo hoặc NULL nếu không có mục nào khác trong danh sách. |
Macro
OT_HISTORY_TRACKER_Entry_AGE_STRING_SIZE
OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE 21
Kích thước đề xuất cho chuỗi đại diện của một độ tuổi nhập.
OT_HISTORY_TRACKER_INFINITE_PATH_COST
OT_HISTORY_TRACKER_INFINITE_PATH_COST 0
Chi phí đường dẫn vô hạn – được sử dụng trong otHistoryTrackerRouterInfo
.
OT_HISTORY_TRACKER_MAX_AGE
OT_HISTORY_TRACKER_MAX_AGE (49 * 24 * 60 * 60 * 1000u)
Hằng số này chỉ định độ tuổi tối đa cho các mục nhập là 49 ngày (tính bằng mili giây).
Các mục cũ hơn tuổi sẽ cho giá trị này là tuổi của chúng.
OT_HISTORY_TRACKER_NO_NEXT_HOP
OT_HISTORY_TRACKER_NO_NEXT_HOP 63
Không có bước tiếp theo – Cho mNextHop
vào otHistoryTrackerRouterInfo
.
Tài nguyên
Các chủ đề Tham chiếu API OpenThread được lấy từ mã nguồn, có sẵn 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.