Google은 흑인 공동체를 위한 인종적 평등을 추구하기 위해 노력하고 있습니다. 자세히 알아보기
컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

인스턴스

이 모듈에는 OpenThread 인스턴스를 제어하는 함수가 포함되어 있습니다.

요약

열거

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_NETWORK_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,
  OT_CHANGED_ACTIVE_DATASET = 1 << 28,
  OT_CHANGED_PENDING_DATASET = 1 << 29
}
enum
이 열거형은 otStateChangedCallback의 일부로 전달되는 플래그를 정의합니다.

Typedef

otChangedFlags typedef
uint32_t
이 유형은 변경된 특정 상태/구성을 나타내는 비트 필드를 나타냅니다.
otInstance typedef
struct otInstance
이 구조는 OpenThread 인스턴스 구조를 나타냅니다.
otStateChangedCallback)(otChangedFlags aFlags, void *aContext) typedef
void(*
이 함수 포인터는 OpenThread 내에서 특정 구성 또는 상태 변경을 알리기 위해 호출됩니다.

함수

otGetRadioVersionString(otInstance *aInstance)
const char *
이 함수는 OpenThread 라디오 버전 문자열을 가져옵니다.
otGetVersionString(void)
const char *
이 함수는 OpenThread 버전 문자열을 가져옵니다.
otInstanceErasePersistentInfo(otInstance *aInstance)
이 함수는 비휘발성 메모리에 저장된 모든 OpenThread 영구 정보 (네트워크 설정)를 삭제합니다.
otInstanceFactoryReset(otInstance *aInstance)
void
비휘발성 메모리에 저장된 모든 설정을 삭제한 다음 플랫폼 재설정을 트리거합니다.
otInstanceFinalize(otInstance *aInstance)
void
이 함수는 OpenThread 라이브러리를 사용 중지합니다.
otInstanceGetUptime(otInstance *aInstance)
uint64_t
이 함수는 현재 인스턴스 업타임 (밀리초 단위)을 반환합니다.
otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize)
void
이 함수는 현재 인스턴스 업타임을 사람이 읽을 수 있는 문자열로 반환합니다.
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
이 함수는 OpenThread 라이브러리를 초기화합니다.
otInstanceInitSingle(void)
이 함수는 OpenThread 라이브러리의 정적 단일 인스턴스를 초기화합니다.
otInstanceIsInitialized(otInstance *aInstance)
bool
이 함수는 인스턴스가 유효하거나 초기화되는지 여부를 나타냅니다.
otInstanceReset(otInstance *aInstance)
void
이 메서드는 플랫폼 재설정을 트리거합니다.
otInstanceResetRadioStack(otInstance *aInstance)
void
이 메서드는 OpenThread 무선 스택의 내부 상태를 재설정합니다.
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
이 함수는 OpenThread 내에서 특정 구성 또는 상태가 변경될 때 이를 나타내는 콜백을 삭제합니다.
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
이 함수는 OpenThread 내에서 특정 구성 또는 상태가 변경될 때를 나타내는 콜백을 등록합니다.

열거형

익명 열거

 anonymous enum

이 열거형은 otStateChangedCallback의 일부로 전달되는 플래그를 정의합니다.

속성
OT_CHANGED_ACTIVE_DATASET

활성 운영 데이터 세트가 변경되었습니다.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

채널 관리자의 새 대기 중인 대화목록 채널이 변경되었습니다.

OT_CHANGED_COMMISSIONER_STATE

감독관 상태가 변경되었습니다.

OT_CHANGED_IP6_ADDRESS_ADDED

IPv6 주소를 추가했습니다.

OT_CHANGED_IP6_ADDRESS_REMOVED

IPv6 주소를 삭제했습니다.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

IPv6 멀티캐스트 주소를 구독했습니다.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

IPv6 멀티캐스트 주소를 구독 취소했습니다.

OT_CHANGED_JOINER_STATE

연결자 상태가 변경되었습니다.

OT_CHANGED_NETWORK_KEY

네트워크 키가 변경되었습니다.

OT_CHANGED_PENDING_DATASET

대기 중인 운영 데이터 세트가 변경되었습니다.

OT_CHANGED_PSKC

PSK가 변경되었습니다.

OT_CHANGED_SECURITY_POLICY

보안 정책이 변경되었습니다.

OT_CHANGED_SUPPORTED_CHANNEL_MASK

지원되는 채널 마스크가 변경되었습니다.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

로컬 백본 라우터 구성이 변경되었습니다.

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

백본 라우터 상태가 변경되었습니다.

OT_CHANGED_THREAD_CHANNEL

대화목록 네트워크 채널이 변경되었습니다.

OT_CHANGED_THREAD_CHILD_ADDED

자녀를 추가했습니다.

OT_CHANGED_THREAD_CHILD_REMOVED

자녀를 삭제했습니다.

OT_CHANGED_THREAD_EXT_PANID

스레드 네트워크 확장 PAN ID가 변경되었습니다.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

대화목록 키 시퀀스가 변경되었습니다.

OT_CHANGED_THREAD_LL_ADDR

링크-로컬 주소가 변경되었습니다.

OT_CHANGED_THREAD_ML_ADDR

메시 로컬 주소가 변경되었습니다.

OT_CHANGED_THREAD_NETDATA

스레드 네트워크 데이터가 변경되었습니다.

OT_CHANGED_THREAD_NETIF_STATE

스레드 네트워크 인터페이스 상태가 변경되었습니다.

OT_CHANGED_THREAD_NETWORK_NAME

대화목록 네트워크 이름이 변경되었습니다.

OT_CHANGED_THREAD_PANID

스레드 네트워크 PAN ID가 변경되었습니다.

OT_CHANGED_THREAD_PARTITION_ID

파티션 ID가 변경되었습니다.

OT_CHANGED_THREAD_RLOC_ADDED

RLOC가 추가되었습니다.

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC를 삭제했습니다.

OT_CHANGED_THREAD_ROLE

역할 (사용 중지, 분리됨, 하위, 라우터, 리더)이 변경되었습니다.

Typedef

otChangedFlags

uint32_t otChangedFlags

이 유형은 변경된 특정 상태/구성을 나타내는 비트 필드를 나타냅니다.

OT_CHANGED_* 정의를 참고하세요.

otInstance

struct otInstance otInstance

이 구조는 OpenThread 인스턴스 구조를 나타냅니다.

otStateChangedCallback

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

이 함수 포인터는 OpenThread 내에서 특정 구성 또는 상태 변경을 알리기 위해 호출됩니다.

세부정보
매개변수
[in] aFlags
변경된 특정 상태를 나타내는 비트 필드입니다. OT_CHANGED_* 정의를 참고하세요.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

함수

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

이 함수는 OpenThread 라디오 버전 문자열을 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
반환
OpenThread 라디오 버전에 대한 포인터입니다.

otGetVersionString

const char * otGetVersionString(
  void
)

이 함수는 OpenThread 버전 문자열을 가져옵니다.

세부정보
반환
OpenThread 버전에 대한 포인터입니다.

otInstanceWipePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

이 함수는 비휘발성 메모리에 저장된 모든 OpenThread 영구 정보 (네트워크 설정)를 삭제합니다.

기기가 disabled 상태/역할인 경우에만 삭제가 성공합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
모든 영구 정보/상태를 삭제했습니다.
OT_ERROR_INVALID_STATE
기기가 disabled 상태/역할이 아닙니다.

초기화

void otInstanceFactoryReset(
  otInstance *aInstance
)

비휘발성 메모리에 저장된 모든 설정을 삭제한 다음 플랫폼 재설정을 트리거합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.

OTInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

이 함수는 OpenThread 라이브러리를 사용 중지합니다.

OpenThread가 더 이상 사용되지 않을 때 이 함수를 호출합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

이 함수는 현재 인스턴스 업타임 (밀리초 단위)을 반환합니다.

이 함수를 사용하려면 OPENTHREAD_CONFIG_UPTIME_ENABLE을 사용 설정해야 합니다.

OpenThread 인스턴스가 초기화된 이후 업타임이 밀리초 단위로 지정됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
반환
업타임 (밀리초 단위)

otInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

이 함수는 현재 인스턴스 업타임을 사람이 읽을 수 있는 문자열로 반환합니다.

이 함수를 사용하려면 OPENTHREAD_CONFIG_UPTIME_ENABLE을 사용 설정해야 합니다.

문자열은 '::.': 시간, 분, 초, 밀리초 (업타임이 1일 미만인 경우) 또는 ' 형식을 따릅니다.

d.::." (하루 이상)

결과 문자열이 aBuffer 문자 (aSize 문자 이내)에 맞지 않으면 문자열이 잘리지만 출력되는 문자열은 항상 null로 종료됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[out] aBuffer
문자열을 출력하는 char 배열에 대한 포인터입니다.
[in] aSize
aBuffer의 크기(바이트) OT_UPTIME_STRING_SIZE을 사용하는 것이 좋습니다.

otInstanceInit

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

이 함수는 OpenThread 라이브러리를 초기화합니다.

이 함수는 OpenThread를 초기화하고 후속 OpenThread API 호출에 대해 준비합니다. 이 함수는 다른 OpenThread 호출 전에 호출되어야 합니다.

이 함수는 여러 OpenThread 인스턴스 지원이 사용 설정된 경우에만 사용할 수 있습니다.

세부정보
매개변수
[in] aInstanceBuffer
otInstance 구조를 할당하는 데 사용할 OpenThread의 버퍼입니다.
[in,out] aInstanceBufferSize
입력 시 aInstanceBuffer의 크기입니다. 출력 시 otInstance에 공간이 충분하지 않으면 otInstance에 필요한 바이트 수입니다.
반환
새 OpenThread 인스턴스에 대한 포인터입니다.
참고:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

이 함수는 OpenThread 라이브러리의 정적 단일 인스턴스를 초기화합니다.

이 함수는 OpenThread를 초기화하고 후속 OpenThread API 호출에 대해 준비합니다. 이 함수는 다른 OpenThread 호출 전에 호출되어야 합니다.

이 함수는 사용할 수 있으며 여러 OpenThread 인스턴스에 대한 지원이 사용 중지된 경우에만 사용할 수 있습니다.

세부정보
반환
단일 OpenThread 인스턴스에 대한 포인터입니다.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

이 함수는 인스턴스가 유효하거나 초기화되는지 여부를 나타냅니다.

otInstanceInitSingle() (단일 인스턴스 케이스) 또는 otInstanceInit() (멀티 인스턴스 케이스)를 사용하여 인스턴스를 가져오고 초기화하면 인스턴스가 유효한 것으로 간주됩니다. 이후에 otInstanceFinalize()를 호출하면 인스턴스가 초기화되지 않은 것으로 간주됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
반환
지정된 인스턴스가 유효하거나 초기화되면 TRUE, 그렇지 않으면 FALSE입니다.

otInstance재설정

void otInstanceReset(
  otInstance *aInstance
)

이 메서드는 플랫폼 재설정을 트리거합니다.

재설정 프로세스는 모든 OpenThread 상태/정보 (휘발성 메모리에 저장됨)를 삭제합니다. otPlatformReset는 비휘발성 메모리에 저장된 영구 상태/정보를 삭제하지 않습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

이 메서드는 OpenThread 무선 스택의 내부 상태를 재설정합니다.

콜백 및 구성은 유지됩니다.

이 API는 라디오 빌드(OPENTHREAD_RADIO = 1)에서만 사용할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.

otRemoveStateChangeCallback

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

이 함수는 OpenThread 내에서 특정 구성 또는 상태가 변경될 때 이를 나타내는 콜백을 삭제합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aCallback
특정 구성 또는 상태 변경으로 호출되는 함수에 대한 포인터입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

otSetStateChangedCallback

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

이 함수는 OpenThread 내에서 특정 구성 또는 상태가 변경될 때를 나타내는 콜백을 등록합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aCallback
특정 구성 또는 상태 변경으로 호출되는 함수에 대한 포인터입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
콜백을 콜백 목록에 추가했습니다.
OT_ERROR_ALREADY
콜백이 이미 등록되었습니다.
OT_ERROR_NO_BUFS
리소스 제약으로 인해 콜백을 추가할 수 없습니다.

매크로

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

업타임의 문자열 표현에 권장되는 크기입니다.

리소스

OpenThread API 참조 주제는 GitHub에서 제공되는 소스 코드에서 비롯됩니다. 자세한 내용을 보거나 문서에 참여하려면 리소스를 참조하세요.