örnek

Bu modül, OpenThread Örneğini denetleyen işlevler içerir.

özet

numaralandırma
anonymous enum { OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3, OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, OT_CHANGED_THREAD_CHANNEL = 1 << 14, OT_CHANGED_THREAD_PANID = 1 << 15, OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, OT_CHANGED_THREAD_EXT_PANID = 1 << 17, OT_CHANGED_MASTER_KEY = 1 << 18, OT_CHANGED_PSKC = 1 << 19, OT_CHANGED_SECURITY_POLICY = 1 << 20, OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, OT_CHANGED_COMMISSIONER_STATE = 1 << 23, OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, OT_CHANGED_JOINER_STATE = 1 << 27 }	Sıralama Bu numaralandırma `otStateChangedCallback` parçası olarak geçirilen bayrakları tanımlar.

numaralandırma

anonymous enum { 
 OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, 
 OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, 
 OT_CHANGED_THREAD_ROLE = 1 << 2, 
 OT_CHANGED_THREAD_LL_ADDR = 1 << 3, 
 OT_CHANGED_THREAD_ML_ADDR = 1 << 4, 
 OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, 
 OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, 
 OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, 
 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, 
 OT_CHANGED_THREAD_NETDATA = 1 << 9, 
 OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, 
 OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, 
 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, 
 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, 
 OT_CHANGED_THREAD_CHANNEL = 1 << 14, 
 OT_CHANGED_THREAD_PANID = 1 << 15, 
 OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, 
 OT_CHANGED_THREAD_EXT_PANID = 1 << 17, 
 OT_CHANGED_MASTER_KEY = 1 << 18, 
 OT_CHANGED_PSKC = 1 << 19, 
 OT_CHANGED_SECURITY_POLICY = 1 << 20, 
 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, 
 OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, 
 OT_CHANGED_COMMISSIONER_STATE = 1 << 23, 
 OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, 
 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, 
 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, 
 OT_CHANGED_JOINER_STATE = 1 << 27 
 }

Sıralama

Bu numaralandırma otStateChangedCallback parçası olarak geçirilen bayrakları tanımlar.

typedefs
`otChangedFlags`	typedef `uint32_t` Bu tür, değişen belirli durumu / yapılandırmayı gösteren bir bit alanını temsil eder.
`otInstance`	typedef `struct otInstance` Bu yapı OpenThread örnek yapısını temsil eder.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Bu işlev işaretçisi, OpenThread içindeki belirli yapılandırma veya durum değişikliklerini bildirmek için çağrılır.

Fonksiyonlar
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Bu işlev OpenThread radyo sürümü dizesini alır.
`otGetVersionString (void)`	`const char *` Bu işlev OpenThread sürüm dizesini alır.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Bu işlev, kalıcı bellekte depolanan tüm OpenThread kalıcı bilgilerini (ağ ayarları) siler.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Bu yöntem, kalıcı bellekte depolanan tüm ayarları siler ve ardından platform sıfırlamasını tetikler.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Bu işlev OpenThread kütüphanesini devre dışı bırakır.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Bu işlev OpenThread kütüphanesini başlatır.
`otInstanceInitSingle (void)`	`otInstance *` Bu işlev, OpenThread kitaplığının statik tek örneğini başlatır.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Bu işlev, örneğin geçerli / başlatılmış olup olmadığını gösterir.
`otInstanceReset ( otInstance *aInstance)`	`void` Bu yöntem bir platform sıfırlamasını tetikler.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Bu işlev, OpenThread içinde belirli yapılandırma veya durumların ne zaman değiştiğini gösteren bir geri aramayı kaldırır.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Bu işlev, OpenThread içinde belirli yapılandırma veya durumun ne zaman değiştiğini belirtmek için bir geri arama kaydeder.

numaralandırma

anonim numaralandırma

 anonymous enum

Bu numaralandırma otStateChangedCallback parçası olarak geçirilen bayrakları tanımlar.

Özellikleri
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Kanal Yöneticisi yeni bekliyor İş parçacığı kanalı değişti.
`OT_CHANGED_COMMISSIONER_STATE`	Komiser devleti değişti.
`OT_CHANGED_IP6_ADDRESS_ADDED`	IPv6 adresi eklendi.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	IPv6 adresi kaldırıldı.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	IPv6 çok noktaya yayın adresine abone oldu.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	IPv6 çok noktaya yayın adresinden aboneliği iptal edilmiştir.
`OT_CHANGED_JOINER_STATE`	Marangoz durumu değişti.
`OT_CHANGED_MASTER_KEY`	Ana anahtar değişti.
`OT_CHANGED_PSKC`	PSKc değişti.
`OT_CHANGED_SECURITY_POLICY`	Güvenlik Politikası değişti.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Desteklenen kanal maskesi değişti.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Yerel Omurga Yönlendirici yapılandırması değişti.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Omurga Yönlendirici durumu değişti.
`OT_CHANGED_THREAD_CHANNEL`	İş parçacığı ağ kanalı değişti.
`OT_CHANGED_THREAD_CHILD_ADDED`	Çocuk eklendi.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Çocuk kaldırıldı.
`OT_CHANGED_THREAD_EXT_PANID`	İş parçacığı ağı genişletilmiş PAN Kimliği değişti.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Konu Tuşu Sırası değişti.
`OT_CHANGED_THREAD_LL_ADDR`	Yerel bağlantı adresi değişti.
`OT_CHANGED_THREAD_ML_ADDR`	Kafes yerel adresi değişti.
`OT_CHANGED_THREAD_NETDATA`	İş Parçacığı Ağı Verileri değişti.
`OT_CHANGED_THREAD_NETIF_STATE`	İş parçacığı ağ arabirimi durumu değişti.
`OT_CHANGED_THREAD_NETWORK_NAME`	İş parçacığı ağ adı değişti.
`OT_CHANGED_THREAD_PANID`	İş parçacığı ağı PAN Kimliği değişti.
`OT_CHANGED_THREAD_PARTITION_ID`	Bölüm kimliği değişti.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC eklendi.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC çıkarıldı.
`OT_CHANGED_THREAD_ROLE`	Rol (devre dışı, ayrılmış, alt, yönlendirici, lider) değişti.

typedefs

otChangedFlags

uint32_t otChangedFlags

Bu tür, değişen belirli durumu / yapılandırmayı gösteren bir bit alanını temsil eder.

Bkz. OT_CHANGED_* tanımları.

otInstance

struct otInstance otInstance

Bu yapı OpenThread örnek yapısını temsil eder.

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

Bu işlev işaretçisi, OpenThread içindeki belirli yapılandırma veya durum değişikliklerini bildirmek için çağrılır.

ayrıntılar

Parametreler

`[in] aFlags`	Değişen belirli durumu gösteren bir bit alanı. Bkz. `OT_CHANGED_*` tanımları.
`[in] aContext`	Uygulamaya özgü bağlama işaretçi.

Fonksiyonlar

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Bu işlev OpenThread radyo sürümü dizesini alır.

ayrıntılar

Parametreler

[in] aInstance

OpenThread örneğine bir işaretçi.

İadeler

OpenThread radyo versiyonuna bir işaretçi.

otGetVersionString

const char * otGetVersionString(
  void
)

Bu işlev OpenThread sürüm dizesini alır.

ayrıntılar
İadeler	OpenThread sürümüne bir işaretçi.

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Bu işlev, kalıcı bellekte depolanan tüm OpenThread kalıcı bilgilerini (ağ ayarları) siler.

Silme işlemi yalnızca cihaz disabled durumunda / rolündeyse başarılı olur.

ayrıntılar

Parametreler

[in] aInstance

OpenThread örneğine bir işaretçi.

Dönüş Değerleri

`OT_ERROR_NONE`	Tüm kalıcı bilgi / durum başarıyla silindi.
`OT_ERROR_INVALID_STATE`	Cihaz `disabled` durumda / rolde değil.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Bu yöntem, kalıcı bellekte depolanan tüm ayarları siler ve ardından platform sıfırlamasını tetikler.

ayrıntılar

Parametreler

[in] aInstance

OpenThread örneğine bir işaretçi.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Bu işlev OpenThread kütüphanesini devre dışı bırakır.

OpenThread artık kullanılmadığında bu işlevi çağırın.

ayrıntılar

Parametreler

[in] aInstance

OpenThread örneğine bir işaretçi.

otInstanceInit

 otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

Bu işlev OpenThread kütüphanesini başlatır.

Bu işlev OpenThread'i başlatır ve sonraki OpenThread API çağrıları için hazırlar. Bu işlev, OpenThread'e yapılan diğer çağrılardan önce çağrılmalıdır.

Bu işlev kullanılabilir ve yalnızca birden çok OpenThread örneği desteği etkinleştirildiğinde kullanılabilir.

ayrıntılar

Parametreler

`[in] aInstanceBuffer`	OtInstance yapısını ayırmak için kullanılacak OpenThread arabelleği.
`[in,out] aInstanceBufferSize`	Girişte, aInstanceBuffer boyutu. Çıktıda, otInstance için yeterli alan yoksa, otInstance için gerekli bayt sayısı.

İadeler

Yeni OpenThread örneğine bir işaretçi.

Ayrıca bakınız:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

Bu işlev, OpenThread kitaplığının statik tek örneğini başlatır.

Bu işlev OpenThread'i başlatır ve sonraki OpenThread API çağrıları için hazırlar. Bu işlev, OpenThread'e yapılan diğer çağrılardan önce çağrılmalıdır.

Bu işlev kullanılabilir ve yalnızca birden çok OpenThread örneği desteği devre dışı bırakıldığında kullanılabilir.

ayrıntılar
İadeler	Tek OpenThread örneğine bir işaretçi.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Bu işlev, örneğin geçerli / başlatılmış olup olmadığını gösterir.

Örnek, otInstanceInitSingle() (tek örnek durumda) veya otInstanceInit() (çoklu örnek durumda) kullanılarak edinilir ve başlatılırsa geçerli sayılır. Bir sonraki otInstanceFinalize() çağrısı, örneğin başlatılmamış olarak değerlendirilmesine neden olur.

ayrıntılar

Parametreler

[in] aInstance

OpenThread örneğine bir işaretçi.

İadeler

Verilen örnek geçerli / başlatılmışsa TRUE, aksi halde FALSE.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Bu yöntem bir platform sıfırlamasını tetikler.

Sıfırlama işlemi, tüm OpenThread durumunun / bilgisinin (geçici bellekte depolanan) silinmesini sağlar. otPlatformReset kalıcı belleğe kaydedilen kalıcı durum / bilgileri otPlatformReset unutmayın.

ayrıntılar

Parametreler

[in] aInstance

OpenThread örneğine bir işaretçi.

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Bu işlev, OpenThread içinde belirli yapılandırma veya durumların ne zaman değiştiğini gösteren bir geri aramayı kaldırır.

ayrıntılar

Parametreler

`[in] aInstance`	OpenThread örneğine bir işaretçi.
`[in] aCallback`	Belirli yapılandırma veya durum değişiklikleriyle çağrılan bir işleve işaretçi.
`[in] aContext`	Uygulamaya özgü bağlama işaretçi.

otSetStateChangedCallback

 otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Bu işlev, OpenThread içinde belirli yapılandırma veya durumun ne zaman değiştiğini belirtmek için bir geri arama kaydeder.

ayrıntılar

Parametreler

`[in] aInstance`	OpenThread örneğine bir işaretçi.
`[in] aCallback`	Belirli yapılandırma veya durum değişiklikleriyle çağrılan bir işleve işaretçi.
`[in] aContext`	Uygulamaya özgü bağlama işaretçi.

Dönüş Değerleri

`OT_ERROR_NONE`	Geri aramalar, geri aramalar listesine eklendi.
`OT_ERROR_ALREADY`	Geri arama zaten kayıtlı.
`OT_ERROR_NO_BUFS`	Kaynak kısıtlamaları nedeniyle geri arama eklenemedi.