라우터/리더

이 모듈에는 스레드 라우터 및 리더용 함수가 포함됩니다.

요약

열거
otCacheEntryState enum
EID 캐시 항목 상태를 정의합니다.
otNeighborTableEvent{
  OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
} 		enum
otNeighborTableCallback에서 이웃 테이블의 변경사항을 나타내는 데 사용되는 상수를 정의합니다.
otPowerSupply{
  OT_POWER_SUPPLY_BATTERY = 0,
  OT_POWER_SUPPLY_EXTERNAL = 1,
  OT_POWER_SUPPLY_EXTERNAL_STABLE = 2,
  OT_POWER_SUPPLY_EXTERNAL_UNSTABLE = 3
} 		enum
기기의 전원 공급 장치 속성을 나타냅니다.

Typedef
otCacheEntryInfo typedef
EID 캐시 항목을 나타냅니다.
otCacheEntryIterator typedef
EID 캐시 테이블 항목을 반복하는 데 사용되는 반복기를 나타냅니다.
otCacheEntryState typedef
EID 캐시 항목 상태를 정의합니다.
otChildIp6AddressIterator typedef
uint16_t
스레드 하위 항목의 IPv6 주소를 반복하는 데 사용됩니다.
otDeviceProperties typedef
기기에서 로컬 리더 가중치를 계산하는 데 사용되는 기기 속성을 나타냅니다.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
이웃 테이블에 변경사항이 있음을 알리기 위해 포인터가 호출됩니다.

함수
otThreadBecomeLeader(otInstance *aInstance)
리더가 되어 새 파티션을 시작합니다.
otThreadBecomeRouter(otInstance *aInstance)
라우터가 되어 봅니다.
otThreadGetAdvertisementTrickleIntervalMax(otInstance *aInstance)
uint32_t
광고 트리클 타이머에서 사용하는 현재 인터벌 최댓값을 가져옵니다.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
연결된 하위 요소의 진단 정보를 하위 요소 ID 또는 RLOC16으로 가져옵니다.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
함수는 내부 테이블 색인으로 연결된 하위 요소의 진단 정보를 보관합니다.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
지정된 하위의 다음 IPv6 주소 (반복기 사용)를 가져옵니다.
otThreadGetChildRouterLinks(otInstance *aInstance)
uint8_t
REED 역할에 사용된 MLE_CHILD_ROUTER_LINKS 매개변수를 가져옵니다.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
리더 역할에 사용된 CONTEXT_ID_REUSE_DELAY 매개변수를 가져옵니다.
otThreadGetDeviceProperties(otInstance *aInstance)
현재 기기 속성을 가져옵니다.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
연결자 UDP 포트를 가져옵니다.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
리더 역할에서 작동할 때 사용되는 스레드 리더 가중치를 가져옵니다.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
현재 허용되는 최대 하위 요소 수를 가져옵니다.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
각 MTD 하위 요소가 이 기기에 상위 요소로 등록할 수 있는 최대 IP 주소 수를 가져옵니다.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
이 함수는 허용되는 최대 라우터 ID를 반환합니다.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
NETWORK_ID_TIMEOUT 매개변수를 가져옵니다.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
반복자를 사용하여 다음 EID 캐시 항목을 가져옵니다.
otThreadGetNextHopAndPathCost(otInstance *aInstance, uint16_t aDestRloc16, uint16_t *aNextHopRloc16, uint8_t *aPathCost)
void
지정된 RLOC16 대상까지의 다음 홉 및 경로 비용을 가져옵니다.
otThreadGetParentPriority(otInstance *aInstance)
int8_t
할당된 상위 우선순위를 가져옵니다.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
리더 역할에서 작업할 때 사용되는 기본 스레드 리더 파티션 ID를 가져옵니다.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
스레드 PSKc를 가져옵니다.
otThreadGetPskcRef(otInstance *aInstance)
저장된 스레드 PSKc에 관한 키 참조 가져오기
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
라우터 역할에 사용된 ROUTER_DOWNGRADE_THRESHOLD 매개변수를 가져옵니다.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
스레드 네트워크 내의 노드에 할당할 수 있는 라우터 ID의 범위를 가져옵니다.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
현재 라우터 ID 시퀀스를 가져옵니다.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
이 함수는 특정 스레드 라우터의 진단 정보를 보관합니다.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
REED/라우터 역할에 사용된 ROUTER_SELECTION_JITTER 매개변수를 가져옵니다.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
REED 역할에 사용된 ROUTER_UPGRADE_THRESHOLD 매개변수를 가져옵니다.
otThreadIsRouterEligible(otInstance *aInstance)
bool
기기가 라우터를 사용할 수 있는지 여부를 나타냅니다.
otThreadIsRouterIdAllocated(otInstance *aInstance, uint8_t aRouterId)
bool
라우터 ID가 현재 할당되어 있는지 여부를 나타냅니다.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
인접 테이블 콜백 함수를 등록합니다.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
리더 역할의 기기에서 할당한 라우터 ID를 해제합니다.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
기기를 CCM을 사용하여 커미셔닝했는지 여부를 설정합니다.
otThreadSetChildRouterLinks(otInstance *aInstance, uint8_t aChildRouterLinks)
REED 역할에 사용되는 MLE_CHILD_ROUTER_LINKS 매개변수를 설정합니다.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
리더 역할에 사용되는 CONTEXT_ID_REUSE_DELAY 매개변수를 설정합니다.
otThreadSetDeviceProperties(otInstance *aInstance, const otDeviceProperties *aDeviceProperties)
void
그런 다음 리더 가중치를 결정하고 설정하는 데 사용할 기기 속성을 설정합니다.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
연결자 UDP 포트를 설정합니다.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
리더 역할로 작업할 때 사용되는 스레드 리더 가중치를 설정합니다.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
현재 허용되는 최대 자녀 수를 설정합니다.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
이 기기에 상위 요소로 등록할 수 있는 각 MTD 하위 요소가 최대 IP 주소 수를 설정하거나 복원합니다.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
NETWORK_ID_TIMEOUT 매개변수를 설정합니다.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
상위 우선순위를 설정합니다.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
리더 역할에서 작업할 때 사용할 기본 스레드 리더 파티션 ID를 설정합니다.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
기본 라우터 ID를 설정합니다.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
스레드 PSKc를 설정합니다.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
키 참조를 스레드 PSKc로 설정합니다.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
리더 역할에 사용되는 ROUTER_DOWNGRADE_THRESHOLD 매개변수를 설정합니다.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
기기가 라우터를 사용할 수 있는지 여부를 설정합니다.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
스레드 네트워크 내의 노드에 할당할 수 있는 라우터 ID의 범위를 설정합니다.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
REED/라우터 역할에 사용되는 ROUTER_SELECTION_JITTER 매개변수를 설정합니다.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
리더 역할에 사용되는 ROUTER_UPGRADE_THRESHOLD 매개변수를 설정합니다.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
스티어링 데이터를 대역 외로 설정합니다.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
라우팅 (VR 필드)에 대한 보안 정책 TLV 버전 기준을 사용 설정할지 설정합니다.

구조체
otCacheEntryInfo

EID 캐시 항목을 나타냅니다.

otCacheEntryIterator

EID 캐시 테이블 항목을 반복하는 데 사용되는 반복기를 나타냅니다.

otChildInfo

Thread Child의 진단 정보를 보유합니다.

otDeviceProperties

기기에서 로컬 리더 가중치를 계산하는 데 사용되는 기기 속성을 나타냅니다.

otNeighborTableEntryInfo

이웃 테이블 항목 정보 (하위 요소 또는 라우터)를 나타내며 이웃 테이블 콜백 otNeighborTableCallback에서 매개변수로 사용됩니다.

열거형

otCacheEntryState

 otCacheEntryState

EID 캐시 항목 상태를 정의합니다.

otNeighborTableEvent

 otNeighborTableEvent

otNeighborTableCallback에서 이웃 테이블의 변경사항을 나타내는 데 사용되는 상수를 정의합니다.

속성
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

자녀를 추가하는 중입니다.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

기존 자녀의 모드가 변경됩니다.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

자녀를 삭제하는 중입니다.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

라우터를 추가하는 중입니다.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

라우터를 삭제하는 중입니다.

otPowerSupply

 otPowerSupply

기기의 전원 공급 장치 속성을 나타냅니다.

리더 가중치를 계산하기 위한 otDeviceProperties의 속성으로 사용됩니다.

속성
OT_POWER_SUPPLY_BATTERY

배터리 전원 사용

OT_POWER_SUPPLY_EXTERNAL

외부 전원 공급 (주전원)

OT_POWER_SUPPLY_EXTERNAL_STABLE

배터리 백업 또는 UPS를 통한 안정적인 외부 전원 공급

OT_POWER_SUPPLY_EXTERNAL_UNSTABLE

불안정할 수 있는 외부 전원 (예: 스위치를 통해 전구에 공급됨)

Typedef

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

EID 캐시 항목을 나타냅니다.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

EID 캐시 테이블 항목을 반복하는 데 사용되는 반복기를 나타냅니다.

반복자를 초기화하고 캐시 테이블의 첫 번째 항목에서 시작하려면 구조의 모든 필드를 0으로 설정합니다 (예: memset 반복자를 0으로 설정합니다.

otCacheEntryState

enum otCacheEntryState otCacheEntryState

EID 캐시 항목 상태를 정의합니다.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

스레드 하위 항목의 IPv6 주소를 반복하는 데 사용됩니다.

otDeviceProperties

struct otDeviceProperties otDeviceProperties

기기에서 로컬 리더 가중치를 계산하는 데 사용되는 기기 속성을 나타냅니다.

매개변수는 기기의 기능, 보더 라우터 역할, 전원 공급 장치 구성 등에 따라 설정됩니다.

mIsUnstable는 기기의 작동 안정성을 나타내며 공급업체별 메커니즘을 통해 결정됩니다. 다음과 같은 경우가 포함될 수 있습니다.

  • 기기에서 외부 전원 공급 장치가 평소보다 더 자주 중단되는 것을 내부적으로 감지합니다. 이는 일반적으로 공급업체에서 결정합니다.
  • 기기가 내부적으로 평소보다 더 자주 재부팅됨을 감지합니다. 이는 일반적으로 공급업체에서 결정합니다.

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

이웃 테이블에 변경사항이 있음을 알리기 위해 포인터가 호출됩니다.

세부정보
매개변수
[in] aEvent
이벤트 플래그.
[in] aEntryInfo
테이블 항목 정보에 대한 포인터입니다.

함수

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

리더가 되어 새 파티션을 시작합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
리더가 되어 새 파티션을 시작했습니다.
OT_ERROR_INVALID_STATE
대화목록이 사용 중지되었습니다.

otThreadBecomeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

라우터가 되어 봅니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
라우터가 되기 위한 시도를 시작합니다.
OT_ERROR_INVALID_STATE
대화목록이 사용 중지되었습니다.

otThreadGetAdvertisementTrickleIntervalMax

uint32_t otThreadGetAdvertisementTrickleIntervalMax(
  otInstance *aInstance
)

광고 트리클 타이머에서 사용하는 현재 인터벌 최댓값을 가져옵니다.

이 API에는 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE가 필요하며 테스트 전용입니다.

세부정보
반환
광고 간격 최댓값(밀리초)입니다.

otThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

연결된 하위 요소의 진단 정보를 하위 요소 ID 또는 RLOC16으로 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aChildId
연결된 하위 요소의 하위 요소 ID 또는 RLOC16.
[out] aChildInfo
하위 요소 정보가 배치되는 위치를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
지정된 ID의 정보로 aChildInfo가 업데이트되었습니다.
OT_ERROR_NOT_FOUND
이 하위 ID를 가진 유효한 하위 항목이 없습니다.
OT_ERROR_INVALID_ARGS
aChildInfo가 NULL인 경우

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

함수는 내부 테이블 색인으로 연결된 하위 요소의 진단 정보를 보관합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aChildIndex
테이블 색인입니다.
[out] aChildInfo
하위 요소 정보가 배치되는 위치를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
지정된 색인의 정보로 aChildInfo가 업데이트되었습니다.
OT_ERROR_NOT_FOUND
이 색인에 유효한 하위 항목이 없습니다.
OT_ERROR_INVALID_ARGS
aChildInfo이(가) NULL이거나 aChildIndex이(가) 범위를 벗어났습니다(최대 테이블 색인보다 높음).
참고 항목:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

지정된 하위의 다음 IPv6 주소 (반복기 사용)를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aChildIndex
하위 색인입니다.
[in,out] aIterator
반복자에 대한 포인터입니다. 성공하면 반복자가 목록의 다음 항목을 가리키도록 업데이트됩니다. 첫 번째 IPv6 주소를 가져오려면 반복자를 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT로 설정해야 합니다.
[out] aAddress
하위 요소의 다음 주소가 배치되는 IPv6 주소에 대한 포인터입니다 (성공 시).
반환 값
OT_ERROR_NONE
다음 IPv6 주소를 찾았습니다(aAddress이(가) 업데이트됨).
OT_ERROR_NOT_FOUND
하위 요소에 후속 IPv6 주소 항목이 없습니다.
OT_ERROR_INVALID_ARGS
aIterator 또는 aAddress이(가) NULL이거나 aChildIndex의 하위 요소가 잘못되었습니다.
참고 항목:
otThreadGetChildInfoByIndex 

uint8_t otThreadGetChildRouterLinks(
  otInstance *aInstance
)

REED 역할에 사용된 MLE_CHILD_ROUTER_LINKS 매개변수를 가져옵니다.

이 매개변수는 기기가 (FED로서) 링크를 설정하려고 시도하는 인접 라우터의 최대 수를 지정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
MLE_CHILD_ROUTER_LINKS 값입니다.
참고 항목:
otThreadSetChildRouterLinks

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

리더 역할에 사용된 CONTEXT_ID_REUSE_DELAY 매개변수를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
CONTEXT_ID_REUSE_DELAY 값입니다.
참고 항목:
otThreadSetContextIdReuseDelay

otThreadGetDeviceProperties

const otDeviceProperties * otThreadGetDeviceProperties(
  otInstance *aInstance
)

현재 기기 속성을 가져옵니다.

OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE가 필요합니다.

세부정보
반환
기기 속성 otDeviceProperties.

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

연결자 UDP 포트를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
연결자 UDP 포트 번호입니다.
참고 항목:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

리더 역할에서 작동할 때 사용되는 스레드 리더 가중치를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
스레드 리더 가중치 값입니다.
참고 항목:
otThreadSetLeaderWeight
otThreadSetDeviceProperties

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

현재 허용되는 최대 하위 요소 수를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
현재 허용되는 최대 자녀 수입니다.
참고 항목:
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

각 MTD 하위 요소가 이 기기에 상위 요소로 등록할 수 있는 최대 IP 주소 수를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
각 MTD 하위 요소가 이 기기에 상위 요소로 등록할 수 있는 최대 IP 주소 수입니다.
참고 항목:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

이 함수는 허용되는 최대 라우터 ID를 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
허용되는 최대 라우터 ID입니다.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

NETWORK_ID_TIMEOUT 매개변수를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
NETWORK_ID_TIMEOUT 값입니다.
참고 항목:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

반복자를 사용하여 다음 EID 캐시 항목을 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[out] aEntryInfo
EID 캐시 항목 정보가 배치되는 위치를 가리키는 포인터입니다.
[in,out] aIterator
반복자에 대한 포인터입니다. 성공 시 다음 항목으로 연결되도록 업데이트됩니다. 첫 번째 항목을 가져오려면 모든 필드를 0으로 설정하여 반복자를 초기화합니다 (예: memset: 반복기 구조를 0으로 설정합니다.
반환 값
OT_ERROR_NONE
다음 EID 캐시 항목의 aEntryInfo이(가) 성공적으로 채워졌습니다.
OT_ERROR_NOT_FOUND
주소 캐시 테이블에 더 이상 항목이 없습니다.

otThreadGetNextHopAndPathCost

void otThreadGetNextHopAndPathCost(
  otInstance *aInstance,
  uint16_t aDestRloc16,
  uint16_t *aNextHopRloc16,
  uint8_t *aPathCost
)

지정된 RLOC16 대상까지의 다음 홉 및 경로 비용을 가져옵니다.

호출자가 값을 가져오려고 하지 않음을 나타내는 NULL인 aNextHopRloc16 또는 aPathCost와 함께 사용할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aDestRloc16
대상의 RLOC16입니다.
[out] aNextHopRloc16
다음 홉의 RLOC16을 반환하는 포인터이며 다음 홉이 없으면 0xfffe를 반환합니다.
[out] aPathCost
대상까지의 경로 비용을 반환하는 포인터입니다.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

할당된 상위 우선순위를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
할당된 상위 우선순위 값, -2는 할당되지 않음을 의미합니다.
참고 항목:
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

리더 역할에서 작업할 때 사용되는 기본 스레드 리더 파티션 ID를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
스레드 리더 파티션 ID 값입니다.

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

스레드 PSKc를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[out] aPskc
검색된 스레드 PSKc를 반환할 otPskc를 가리키는 포인터입니다.
참고 항목:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

저장된 스레드 PSKc에 관한 키 참조 가져오기

빌드 시간 기능 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE를 사용 설정해야 합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
PSKc에 대한 주요 참조
참고 항목:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

라우터 역할에 사용된 ROUTER_DOWNGRADE_THRESHOLD 매개변수를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
ROUTER_DOWNGRADE_THRESHOLD 값입니다.
참고 항목:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

스레드 네트워크 내의 노드에 할당할 수 있는 라우터 ID의 범위를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[out] aMinRouterId
최소 라우터 ID입니다.
[out] aMaxRouterId
최대 라우터 ID입니다.
참고 항목:
otThreadSetRouterIdRange

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

현재 라우터 ID 시퀀스를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
라우터 ID 순서입니다.

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

이 함수는 특정 스레드 라우터의 진단 정보를 보관합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aRouterId
지정된 라우터의 라우터 ID 또는 RLOC16입니다.
[out] aRouterInfo
라우터 정보가 있는 위치를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
지정된 ID에 대한 라우터 정보를 가져왔습니다.
OT_ERROR_NOT_FOUND
지정된 ID를 가진 라우터 항목이 없습니다.
OT_ERROR_INVALID_ARGS
aRouterInfo이(가) NULL입니다.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

REED/라우터 역할에 사용된 ROUTER_SELECTION_JITTER 매개변수를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
ROUTER_SELECTION_JITTER 값입니다.
참고 항목:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

REED 역할에 사용된 ROUTER_UPGRADE_THRESHOLD 매개변수를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
ROUTER_UPGRADE_THRESHOLD 값입니다.
참고 항목:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

기기가 라우터를 사용할 수 있는지 여부를 나타냅니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환 값
TRUE
라우터를 사용할 수 있는 기기인 경우
FALSE
라우터를 사용할 수 없는 기기인 경우

otThreadIsRouterIdAllocated

bool otThreadIsRouterIdAllocated(
  otInstance *aInstance,
  uint8_t aRouterId
)

라우터 ID가 현재 할당되어 있는지 여부를 나타냅니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aRouterId
확인할 라우터 ID입니다.
반환 값
TRUE
aRouterId가 할당됩니다.
FALSE
aRouterId는 할당되지 않았습니다.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

인접 테이블 콜백 함수를 등록합니다.

NULL이 아닌 경우 제공된 콜백은 인접 테이블에 변경사항이 있을 때(예: 하위 요소 또는 라우터 이웃 항목이 추가/삭제되거나 기존 하위 요소의 모드가 변경될 때) 호출됩니다.

이후에 이 메서드를 호출하면 이전 콜백을 덮어씁니다. 이 콜백은 인접 항목/하위 테이블이 업데이트되는 동안 그리고 항상 otStateChangedCallback 전에 호출됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aCallback
콜백 핸들러 함수에 대한 포인터입니다.

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

리더 역할의 기기에서 할당한 라우터 ID를 해제합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aRouterId
해제할 라우터 ID입니다. 유효한 범위는 [0, 62]입니다.
반환 값
OT_ERROR_NONE
라우터 ID를 해제했습니다.
OT_ERROR_INVALID_ARGS
aRouterId이(가) [0, 62] 범위 내에 있지 않습니다.
OT_ERROR_INVALID_STATE
기기가 현재 리더로 작동하지 않습니다.
OT_ERROR_NOT_FOUND
라우터 ID가 현재 할당되지 않았습니다.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

기기를 CCM을 사용하여 커미셔닝했는지 여부를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aEnabled
기기가 CCM을 사용하여 시운전되면 TRUE, 그렇지 않으면 FALSE입니다. 
otError otThreadSetChildRouterLinks(
  otInstance *aInstance,
  uint8_t aChildRouterLinks
)

REED 역할에 사용되는 MLE_CHILD_ROUTER_LINKS 매개변수를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aChildRouterLinks
MLE_CHILD_ROUTER_LINKS 값입니다.
반환 값
OT_ERROR_NONE
값을 설정했습니다.
OT_ERROR_INVALID_STATE
스레드 프로토콜이 사용 설정되었습니다.
참고 항목:
otThreadGetChildRouterLinks

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

리더 역할에 사용되는 CONTEXT_ID_REUSE_DELAY 매개변수를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aDelay
CONTEXT_ID_REUSE_DELAY 값입니다.
참고 항목:
otThreadGetContextIdReuseDelay

otThreadSetDeviceProperties

void otThreadSetDeviceProperties(
  otInstance *aInstance,
  const otDeviceProperties *aDeviceProperties
)

그런 다음 리더 가중치를 결정하고 설정하는 데 사용할 기기 속성을 설정합니다.

OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE가 필요합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aDeviceProperties
기기 속성입니다.

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

연결자 UDP 포트를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aJoinerUdpPort
연결자 UDP 포트 번호입니다.
반환 값
OT_ERROR_NONE
연결자 UDP 포트를 설정했습니다.
참고 항목:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

리더 역할로 작업할 때 사용되는 스레드 리더 가중치를 설정합니다.

리더 가중치를 새 값으로 직접 설정하여 이전 값 (현재 otDeviceProperties에서 결정되었을 수 있음)을 대체합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aWeight
스레드 리더 가중치 값입니다.
참고 항목:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

현재 허용되는 최대 자녀 수를 설정합니다.

이 매개변수는 스레드 프로토콜 작업이 중지된 경우에만 설정할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aMaxChildren
허용되는 최대 하위 요소입니다.
반환 값
OT_ERROR_NONE
최대
OT_ERROR_INVALID_ARGS
aMaxChildren가 [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN] 범위 내에 있지 않은 경우
OT_ERROR_INVALID_STATE
스레드가 중지되지 않은 경우
참고 항목:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

이 기기에 상위 요소로 등록할 수 있는 각 MTD 하위 요소가 최대 IP 주소 수를 설정하거나 복원합니다.

0를 전달하여 설정을 지우고 기본값을 복원합니다.

OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE가 사용 설정된 경우 사용 가능합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aMaxIpAddresses
각 MTD 하위 요소가 이 기기에 상위 요소로 등록할 수 있는 최대 IP 주소 수입니다. 0: 설정을 지우고 기본값으로 복원합니다.
반환 값
OT_ERROR_NONE
번호를 성공적으로 설정/삭제했습니다.
OT_ERROR_INVALID_ARGS
허용되는 최대 개수를 초과하는 경우입니다.
참고 항목:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

NETWORK_ID_TIMEOUT 매개변수를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aTimeout
NETWORK_ID_TIMEOUT 값입니다.
참고 항목:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

상위 우선순위를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aParentPriority
상위 우선순위 값입니다.
반환 값
OT_ERROR_NONE
상위 우선순위를 설정했습니다.
OT_ERROR_INVALID_ARGS
상위 우선순위 값이 1, 0, -1, -2 중 하나가 아닌 경우입니다.
참고 항목:
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

리더 역할에서 작업할 때 사용할 기본 스레드 리더 파티션 ID를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aPartitionId
스레드 리더 파티션 ID 값입니다.

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

기본 라우터 ID를 설정합니다.

라우터/리더가 되면 노드는 이 라우터 ID를 사용하려고 합니다. 기본 라우터 ID가 설정되지 않았거나 사용할 수 없는 경우 임의로 생성된 라우터 ID가 선택됩니다. 이 속성은 기기 역할이 분리되거나 사용 중지된 경우에만 설정할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aRouterId
기본 라우터 ID
반환 값
OT_ERROR_NONE
기본 라우터 ID를 설정했습니다.
OT_ERROR_INVALID_STATE
설정할 수 없습니다 (역할이 분리되거나 사용 중지되지 않음).

otThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

스레드 PSKc를 설정합니다.

스레드 프로토콜이 사용 중지된 경우에만 성공합니다. 이 함수를 성공적으로 호출하면 비휘발성 메모리에서 활성 및 대기 중인 운영 데이터 세트도 무효화됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aPskc
새 스레드 PSKc의 포인터입니다.
반환 값
OT_ERROR_NONE
스레드 PSKc를 설정했습니다.
OT_ERROR_INVALID_STATE
스레드 프로토콜이 사용 설정되었습니다.
참고 항목:
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

키 참조를 스레드 PSKc로 설정합니다.

빌드 시간 기능 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE를 사용 설정해야 합니다.

스레드 프로토콜이 사용 중지된 경우에만 성공합니다. 성공 시 비휘발성 메모리에서 활성 및 대기 중인 운영 데이터 세트도 무효화됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aKeyRef
새 스레드 PSKc에 관한 키 참조
반환 값
OT_ERROR_NONE
스레드 PSKc를 설정했습니다.
OT_ERROR_INVALID_STATE
스레드 프로토콜이 사용 설정되었습니다.
참고 항목:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

리더 역할에 사용되는 ROUTER_DOWNGRADE_THRESHOLD 매개변수를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aThreshold
ROUTER_DOWNGRADE_THRESHOLD 값입니다.
참고 항목:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

기기가 라우터를 사용할 수 있는지 여부를 설정합니다.

aEligible가 false이고 기기가 현재 라우터로 작동 중인 경우 이 호출로 인해 기기가 분리되고 하위 요소로 다시 연결하려고 시도합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aEligible
기기를 라우터에 적합하도록 구성하려면 TRUE, 그렇지 않으면 FALSE입니다.
반환 값
OT_ERROR_NONE
라우터 사용 가능 구성을 설정했습니다.
OT_ERROR_NOT_CAPABLE
기기를 라우터로 사용할 수 없습니다.

otThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

스레드 네트워크 내의 노드에 할당할 수 있는 라우터 ID의 범위를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aMinRouterId
최소 라우터 ID입니다.
[in] aMaxRouterId
최대 라우터 ID입니다.
반환 값
OT_ERROR_NONE
범위를 설정했습니다.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId이거나 범위가 [0, 62]에 포함되지 않음
참고 항목:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

REED/라우터 역할에 사용되는 ROUTER_SELECTION_JITTER 매개변수를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aRouterJitter
ROUTER_SELECTION_JITTER 값입니다.
참고 항목:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

리더 역할에 사용되는 ROUTER_UPGRADE_THRESHOLD 매개변수를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aThreshold
ROUTER_UPGRADE_THRESHOLD 값입니다.
참고 항목:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

스티어링 데이터를 대역 외로 설정합니다.

조정 데이터 대역 외 설정을 사용 설정하려면 구성 옵션 OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE을(를) 설정해야 합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aExtAddress
핸들 데이터를 업데이트하는 데 사용되는 주소입니다. 모두 0으로 설정하여 스티어링 데이터를 지웁니다 (스티어링 데이터 없음). 모두 0xFF는 스티어링 데이터/블룸 필터를 모두 허용/허용하도록 설정합니다. 특정 EUI64가 현재 스티어링 데이터/블룸 필터에 추가됩니다.

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

라우팅 (VR 필드)에 대한 보안 정책 TLV 버전 기준을 사용 설정할지 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aEnabled
라우팅에 보안 정책 TLV 버전 기준을 사용 설정하려면 TRUE, 사용하지 않으려면 FALSE입니다.

매크로

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

otChildIP6AddressIterator의 이니셜라이저입니다.

자료

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