מעבד/ת רשת

המודול הזה כולל פונקציות ששולטות בביצוע השרשור.

סיכום

סוג Dedef

otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount) Typedef
bool(*
הגדרת סוג האצלה (מצביע פונקציה) כדי לשלוט בהתנהגות של פעולת הצצה/פוקה.
otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress) Typedef
void(*
מגדיר את סוג ה-handler (מצביע פונקציות) להפעלת תהליך ההצטרפות.
otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix) Typedef
void(*
הגדרת סוג handler (מצביע פונקציות) עבור הגדרת קידומת ULA מדור קודם.
otNcpHandlerStartLegacy)(void) Typedef
void(*
הגדרת סוג handler (מצביע פונקציות) עבור הפעלת רשת מדור קודם.
otNcpHandlerStopLegacy)(void) Typedef
void(*
הגדרת סוג handler (מצביע פונקציות) לצורך עצירה של רשת מדור קודם.
otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength) Typedef
int(*
מצביע הפונקציה הזה נשלח כדי לשלוח נתוני NCP בקידוד HDLC.
otNcpLegacyHandlers Typedef
מגדיר מבנה שמכיל את כל רכיבי ה-handler הישנים (מצביעי פונקציות).

פונקציות

otNcpHandleDidReceiveNewLegacyUlaPrefix(const uint8_t *aUlaPrefix)
void
הקריאה החוזרת הזו מופעלת על ידי המחסנית מדור קודם כדי ליידע שהקידומת של ULA מדור קודם השתנתה.
otNcpHandleLegacyNodeDidJoin(const otExtAddress *aExtAddr)
void
הקריאה החוזרת הזו מופעלת על ידי המחסנית מדור קודם כדי להודיע שצומת מדור קודם אכן הצטרף לרשת.
otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
מאתחלים את ה-NCP על סמך מסגור של HDLC.
otNcpHdlcReceive(const uint8_t *aBuf, uint16_t aBufLength)
void
פונקציה זו נקראת לאחר קבלת נתוני NCP בקידוד LCHD.
otNcpHdlcSendDone(void)
void
פונקציית פונקציה זו נקראת בסיום שליחת NCP.
otNcpPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
כתיבת יומן OpenThread באמצעות otNcpStreamWrite.
otNcpRegisterLegacyHandlers(const otNcpLegacyHandlers *aHandlers)
void
השיטה הזו רושמת קבוצה של רכיבי handler מדור קודם עם NCP.
otNcpRegisterPeekPokeDelagates(otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)
void
השיטה הזו מתעדת פונקציות של האצלה/פקודה באמצעות מודול NCP.
otNcpSpiInit(otInstance *aInstance)
void
מאתחלים את ה-NCP על סמך מסגור של SPI.
otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen)
שליחת נתונים למארח דרך שידור ספציפי.

מבנים

otNcpLegacyHandlers

מגדיר מבנה שמכיל את כל רכיבי ה-handler הישנים (מצביעי פונקציות).

סוג Dedef

otNcpDelegateAllowPeekPoke

bool(* otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount)

הגדרת סוג האצלה (מצביע פונקציה) כדי לשלוט בהתנהגות של פעולת הצצה/פוקה.

פונקציית ההאצלה הזו נקראת כדי לקבוע אם לאפשר הצצה או פקטה על אזור זיכרון מסוים. הוא משמש אם תמיכה ב-NCP עבור פקודות הצצה/פקוק מופעלת.

פרטים
פרמטרים
[in] aAddress
כתובת ההתחלה של אזור הזיכרון.
[in] aCount
מספר הבייטים להצצה או פקק.
החזרות
TRUE כדי לאפשר הצצה/איתור של אזור הזיכרון הנתון, אחרת FALSE.

otNcpHandlerjoinLegacyNode

void(* otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress)

מגדיר את סוג ה-handler (מצביע פונקציות) להפעלת תהליך ההצטרפות.

התבצעה הפעלה של הליך הצטרפות מדור קודם לצומת מסוים או לצומת ספציפי.

פרטים
פרמטרים
[in] aExtAddress
מצביעים על הכתובת המורחבת של הצומת כדי להצטרף, או על NULL אם רוצים להצטרף לכל צומת סמוך.

otNcpHandlerSetLegacyUlaPrefix

void(* otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix)

הגדרת סוג handler (מצביע פונקציות) עבור הגדרת קידומת ULA מדור קודם.

הפעלה להגדרת קידומת ULA מדור קודם.

פרטים
פרמטרים
[in] aUlaPrefix
מצביע על מאגר נתונים זמני שמכיל את קידומת ה-ULA מהדור הקודם.

OTNcpHandlerStartLegacy

void(* otNcpHandlerStartLegacy)(void)

הגדרת סוג handler (מצביע פונקציות) עבור הפעלת רשת מדור קודם.

הופעל כדי להפעיל את הרשת מהדור הקודם.

OTNcpHandlerStopLegacy

void(* otNcpHandlerStopLegacy)(void)

הגדרת סוג handler (מצביע פונקציות) לצורך עצירה של רשת מדור קודם.

התבצעה הפעלה כדי להפסיק את הרשת מהדור הקודם.

otNcpHdlcSendCallback

int(* otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength)

מצביע הפונקציה הזה נשלח כדי לשלוח נתוני NCP בקידוד HDLC.

פרטים
פרמטרים
[in] aBuf
מצביע למאגר נתונים עם פלט.
[in] aBufLength
אורך של נתוני הפלט המאוחסנים במאגר.
החזרות
מספר הבייטים שעובדו על ידי הקריאה החוזרת (callback).

OTNcpLegacyHandlers

struct otNcpLegacyHandlers otNcpLegacyHandlers

מגדיר מבנה שמכיל את כל רכיבי ה-handler הישנים (מצביעי פונקציות).

פונקציות

otNcpHandleSinceNewLegacyUlaPrefix

void otNcpHandleDidReceiveNewLegacyUlaPrefix(
  const uint8_t *aUlaPrefix
)

הקריאה החוזרת הזו מופעלת על ידי המחסנית מדור קודם כדי ליידע שהקידומת של ULA מדור קודם השתנתה.

פרטים
פרמטרים
[in] aUlaPrefix
מצביע לקידומת ULA שהתקבלה.

otNcpHandleLegacyNodeDoneהצטרפות

void otNcpHandleLegacyNodeDidJoin(
  const otExtAddress *aExtAddr
)

הקריאה החוזרת הזו מופעלת על ידי המחסנית מדור קודם כדי להודיע שצומת מדור קודם אכן הצטרף לרשת.

פרטים
פרמטרים
[in] aExtAddr
מצביע על הכתובת המורחבת של הצומת המחובר.

otNcpHdlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

מאתחלים את ה-NCP על סמך מסגור של HDLC.

פרטים
פרמטרים
[in] aInstance
מבנה המופע של OpenThread.
[in] aSendCallback
מצביע הפונקציה המשמש לשליחת נתוני NCP.

otNcpHdlcGet

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

פונקציה זו נקראת לאחר קבלת נתוני NCP בקידוד LCHD.

פרטים
פרמטרים
[in] aBuf
מצביע למאגר נתונים זמני.
[in] aBufLength
אורך הנתונים המאוחסנים במאגר.

OTNcpHdlcSendDone

void otNcpHdlcSendDone(
  void
)

פונקציית פונקציה זו נקראת בסיום שליחת NCP.

OTNcpPlatLogv

void otNcpPlatLogv(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aFormat,
  va_list aArgs
)

כתיבת יומן OpenThread באמצעות otNcpStreamWrite.

פרטים
פרמטרים
[in] aLogLevel
רמת היומן.
[in] aLogRegion
אזור היומן.
[in] aFormat
מצביע על מחרוזת הפורמט.
[in] aArgs
va_list תואם ל-aformat.

otNcpenrollLegacyHandlers

void otNcpRegisterLegacyHandlers(
  const otNcpLegacyHandlers *aHandlers
)

השיטה הזו רושמת קבוצה של רכיבי handler מדור קודם עם NCP.

קבוצת ה-handlers שסופקו על ידי המבנה aHandlers משמשת לקוד NCP כדי להפעיל/להפסיק את הרשת מהדור הקודם. המדיניות aHandlers יכולה להיות NULL כדי להשבית תמיכה מדור קודם ב-NCP. גם רכיבי handler נפרדים במבנה של handlers מסוימים יכולים להיות NULL.

פרטים
פרמטרים
[in] aHandlers
מצביע על מבנה של handler.

otNcpenrollPeekPokeDelagates

void otNcpRegisterPeekPokeDelagates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

השיטה הזו מתעדת פונקציות של האצלה/פקודה באמצעות מודול NCP.

פונקציות ההענקת גישה נקראות על ידי מודול NCP כדי להחליט אם לאפשר הצצה או נטייה של אזור זיכרון ספציפי. אם מצביע מקבל הגישה מוגדר ל-NULL, הוא מאפשר לבצע פעולת הצצה לכל כתובת.

פרטים
פרמטרים
[in] aAllowPeekDelegate
האצלת מצביע פונקציה לביצוע הצצה.
[in] aAllowPokeDelegate
האצלת מצביע פונקציות לפעולת poke.

otNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

מאתחלים את ה-NCP על סמך מסגור של SPI.

פרטים
פרמטרים
[in] aInstance
מבנה המופע של OpenThread.

otNcpStreamWrite

otError otNcpStreamWrite(
  int aStreamId,
  const uint8_t *aDataPtr,
  int aDataLen
)

שליחת נתונים למארח דרך שידור ספציפי.

פונקציה זו מנסה לשלוח את הנתונים הנתונים למארח באמצעות פרמטר AStreamId הנתון. המדיניות הזו שימושית לדיווח על הודעות שגיאה, להטמעת מסופים של ניפוי באגים/אבחון ואפשרות לסוגים אחרים של מקורות נתונים.

הכתיבה אושרה במלואה או נדחתה. לא מתבצע ניסיון כתיבה חלקי.

פרטים
פרמטרים
[in] aStreamId
מזהה מספרי של השידור שאליו ניתן לכתוב. אם היא מוגדרת כ-'0', ברירת המחדל תהיה זרם ניפוי הבאגים.
[in] aDataPtr
מצביע על הנתונים לשליחת השידור. אם aDataLen אינו אפס, הפרמטר הזה חייב להיות NULL.
[in] aDataLen
מספר הבייטים מ-aDataPtr שיש לשלוח.
ערכי החזרה
OT_ERROR_NONE
הנתונים הועברו לתור למארח.
OT_ERROR_BUSY
אין מספיק משאבים כדי להשלים את הבקשה הזו. זהו בדרך כלל תנאי זמני.
OT_ERROR_INVALID_ARGS
ה-aStreamId הנתון לא היה חוקי.

פקודות מאקרו

OT_NCP_LEGACY_ULA_rfc_LENGTH

 OT_NCP_LEGACY_ULA_PREFIX_LENGTH 8

גודל ULA מדור קודם (בבייטים)

משאבים

נושאי עזר של OpenThread API מגיעים מקוד המקור, שזמין ב-GitHub. למידע נוסף או כדי להוסיף מידע למסמכים שלנו, יש לעיין במשאבים.