SRP : 검색결과 페이지

이 모듈에는 SRP 클라이언트 동작을 제어하는 함수가 포함되어 있습니다.

요약

이 모듈에는 서비스 등록 프로토콜의 기능이 포함됩니다.

이 모듈에는 SRP 클라이언트 버퍼 및 서비스 풀용 함수가 포함되어 있습니다.

이 모듈의 함수는 OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_ENABLE 기능이 사용 설정된 경우에만 사용할 수 있습니다.

열거형
otSrpClientItemState{
  OT_SRP_CLIENT_ITEM_STATE_TO_ADD,
  OT_SRP_CLIENT_ITEM_STATE_ADDING,
  OT_SRP_CLIENT_ITEM_STATE_TO_REFRESH,
  OT_SRP_CLIENT_ITEM_STATE_REFRESHING,
  OT_SRP_CLIENT_ITEM_STATE_TO_REMOVE,
  OT_SRP_CLIENT_ITEM_STATE_REMOVING,
  OT_SRP_CLIENT_ITEM_STATE_REGISTERED,
  OT_SRP_CLIENT_ITEM_STATE_REMOVED
} 		enum
SRP 클라이언트 항목 (서비스 또는 호스트 정보) 상태를 지정합니다.
otSrpServerAddressMode{
  OT_SRP_SERVER_ADDRESS_MODE_UNICAST = 0,
  OT_SRP_SERVER_ADDRESS_MODE_ANYCAST = 1
} 		enum
SRP 서버가 사용하는 주소 모드를 나타냅니다.
otSrpServerState{
  OT_SRP_SERVER_STATE_DISABLED = 0,
  OT_SRP_SERVER_STATE_RUNNING = 1,
  OT_SRP_SERVER_STATE_STOPPED = 2
} 		enum
SRP 서버의 상태를 나타냅니다.

Typedef
otSrpClientAutoStartCallback)(const otSockAddr *aServerSockAddr, void *aContext) typedef
void(*
포인터 유형은 SRP 클라이언트가 자동 시작되거나 중지될 때 사용자에게 알리기 위해 사용하는 콜백을 정의합니다.
otSrpClientBuffersServiceEntry typedef
SRP 클라이언트 서비스 풀 항목을 나타냅니다.
otSrpClientCallback)(otError aError, const otSrpClientHostInfo *aHostInfo, const otSrpClientService *aServices, const otSrpClientService *aRemovedServices, void *aContext) typedef
void(*
포인터 유형은 SRP 클라이언트에서 사용자에게 변경사항/이벤트/오류를 알리는 데 사용하는 콜백을 정의합니다.
otSrpClientHostInfo typedef
SRP 클라이언트 호스트 정보를 나타냅니다.
otSrpClientService typedef
SRP 클라이언트 서비스를 나타냅니다.
otSrpServerAddressMode typedef
SRP 서버가 사용하는 주소 모드를 나타냅니다.
otSrpServerHost typedef
이 불투명 유형은 SRP 서비스 호스트를 나타냅니다.
otSrpServerLeaseConfig typedef
SRP 서버 LEASE 및 KEY-LEASE 구성이 포함됩니다.
otSrpServerLeaseInfo typedef
호스트/서비스의 SRP 서버 임대 정보가 포함됩니다.
otSrpServerResponseCounters typedef
SRP 서버 응답 통계가 포함됩니다.
otSrpServerService typedef
이 불투명 유형은 SRP 서비스를 나타냅니다.
otSrpServerServiceUpdateHandler)(otSrpServerServiceUpdateId aId, const otSrpServerHost *aHost, uint32_t aTimeout, void *aContext) typedef
void(*
SRP 서비스 업데이트를 처리합니다.
otSrpServerServiceUpdateId typedef
uint32_t
SRP 서버의 SRP 서비스 업데이트 트랜잭션 ID입니다.
otSrpServerTtlConfig typedef
SRP 서버 TTL 구성이 포함됩니다.

함수
otSrpClientAddService(otInstance *aInstance, otSrpClientService *aService)
서버에 등록할 서비스를 추가합니다.
otSrpClientBuffersAllocateService(otInstance *aInstance)
풀에서 새 서비스 항목을 할당합니다.
otSrpClientBuffersFreeAllServices(otInstance *aInstance)
void
이전에 할당된 모든 서비스 항목을 해제합니다.
otSrpClientBuffersFreeService(otInstance *aInstance, otSrpClientBuffersServiceEntry *aService)
void
이전에 할당된 서비스 항목을 해제합니다.
otSrpClientBuffersGetHostAddressesArray(otInstance *aInstance, uint8_t *aArrayLength)
SRP 클라이언트 호스트 주소 목록으로 사용할 IPv6 주소 항목의 배열을 가져옵니다.
otSrpClientBuffersGetHostNameString(otInstance *aInstance, uint16_t *aSize)
char *
SRP 클라이언트 호스트 이름에 사용할 문자열 버퍼를 가져옵니다.
otSrpClientBuffersGetServiceEntryInstanceNameString(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize)
char *
서비스 항목에서 서비스 인스턴스 이름의 문자열 버퍼를 가져옵니다.
otSrpClientBuffersGetServiceEntryServiceNameString(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize)
char *
서비스 항목에서 서비스 이름의 문자열 버퍼를 가져옵니다.
otSrpClientBuffersGetServiceEntryTxtBuffer(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize)
uint8_t *
서비스 항목에서 TXT 레코드의 버퍼를 가져옵니다.
otSrpClientBuffersGetSubTypeLabelsArray(otSrpClientBuffersServiceEntry *aEntry, uint16_t *aArrayLength)
const char **
서비스 항목에서 서비스 하위유형 라벨의 배열을 가져옵니다.
otSrpClientClearHostAndServices(otInstance *aInstance)
void
모든 호스트 정보와 서비스를 지웁니다.
otSrpClientClearService(otInstance *aInstance, otSrpClientService *aService)
서비스를 지우고 클라이언트 서비스 목록에서 즉시 삭제합니다.
otSrpClientDisableAutoStartMode(otInstance *aInstance)
void
자동 시작 모드를 사용 중지합니다.
otSrpClientEnableAutoHostAddress(otInstance *aInstance)
자동 호스트 주소 모드를 사용 설정합니다.
otSrpClientEnableAutoStartMode(otInstance *aInstance, otSrpClientAutoStartCallback aCallback, void *aContext)
void
자동 시작 모드를 사용 설정합니다.
otSrpClientGetDomainName(otInstance *aInstance)
const char *
SRP 클라이언트에서 사용 중인 도메인 이름을 가져옵니다.
otSrpClientGetHostInfo(otInstance *aInstance)
호스트 정보를 가져옵니다.
otSrpClientGetKeyLeaseInterval(otInstance *aInstance)
uint32_t
SRP 업데이트 요청에 사용되는 기본 키 임대 간격을 가져옵니다.
otSrpClientGetLeaseInterval(otInstance *aInstance)
uint32_t
SRP 업데이트 요청에 사용되는 기본 임대 간격을 가져옵니다.
otSrpClientGetServerAddress(otInstance *aInstance)
const otSockAddr *
SRP 클라이언트가 사용하는 SRP 서버의 소켓 주소 (IPv6 주소 및 포트 번호)를 가져옵니다.
otSrpClientGetServices(otInstance *aInstance)
클라이언트가 관리하는 서비스의 목록을 가져옵니다.
otSrpClientGetTtl(otInstance *aInstance)
uint32_t
SRP 업데이트 요청에 포함된 모든 레코드의 TTL 값을 가져옵니다.
otSrpClientIsAutoStartModeEnabled(otInstance *aInstance)
bool
자동 시작 모드의 현재 상태 (사용 설정 또는 사용 중지)를 나타냅니다.
otSrpClientIsRunning(otInstance *aInstance)
bool
SRP 클라이언트가 실행 중인지 여부를 나타냅니다.
otSrpClientIsServiceKeyRecordEnabled(otInstance *aInstance)
bool
'서비스 키 레코드 포함' 모드의 사용 설정 여부를 나타냅니다.
otSrpClientItemStateToString(otSrpClientItemState aItemState)
const char *
otSrpClientItemState를 문자열로 변환합니다.
otSrpClientRemoveHostAndServices(otInstance *aInstance, bool aRemoveKeyLease, bool aSendUnregToServer)
호스트 정보 및 모든 서비스의 삭제 프로세스를 시작합니다.
otSrpClientRemoveService(otInstance *aInstance, otSrpClientService *aService)
서비스를 서버에 등록 해제하도록 요청합니다.
otSrpClientSetCallback(otInstance *aInstance, otSrpClientCallback aCallback, void *aContext)
void
호출자에게 SRP 클라이언트의 이벤트/변경사항을 알리도록 콜백을 설정합니다.
otSrpClientSetDomainName(otInstance *aInstance, const char *aName)
SRP 클라이언트가 사용할 도메인 이름을 설정합니다.
otSrpClientSetHostAddresses(otInstance *aInstance, const otIp6Address *aIp6Addresses, uint8_t aNumAddresses)
호스트 IPv6 주소 목록을 설정/업데이트합니다.
otSrpClientSetHostName(otInstance *aInstance, const char *aName)
호스트 이름 라벨을 설정합니다.
otSrpClientSetKeyLeaseInterval(otInstance *aInstance, uint32_t aInterval)
void
SRP 업데이트 요청에 사용되는 기본 키 임대 간격을 설정합니다.
otSrpClientSetLeaseInterval(otInstance *aInstance, uint32_t aInterval)
void
SRP 업데이트 요청에 사용되는 기본 임대 간격을 설정합니다.
otSrpClientSetServiceKeyRecordEnabled(otInstance *aInstance, bool aEnabled)
void
'서비스 키 레코드 포함' 모드를 사용 설정/사용 중지합니다.
otSrpClientSetTtl(otInstance *aInstance, uint32_t aTtl)
void
SRP 업데이트 요청에 포함된 모든 레코드에 TTL 값을 설정합니다.
otSrpClientStart(otInstance *aInstance, const otSockAddr *aServerSockAddr)
SRP 클라이언트 작업을 시작합니다.
otSrpClientStop(otInstance *aInstance)
void
SRP 클라이언트 작업을 중지합니다.
otSrpServerGetAddressMode(otInstance *aInstance)
SRP 서버가 사용 중인 주소 모드를 반환합니다.
otSrpServerGetAnycastModeSequenceNumber(otInstance *aInstance)
uint8_t
애니캐스트 주소 모드에서 사용된 시퀀스 번호를 반환합니다.
otSrpServerGetDomain(otInstance *aInstance)
const char *
SRP 서버에 승인된 도메인을 반환합니다.
otSrpServerGetLeaseConfig(otInstance *aInstance, otSrpServerLeaseConfig *aLeaseConfig)
void
SRP 서버 LEASE 및 KEY-LEASE 구성을 반환합니다.
otSrpServerGetNextHost(otInstance *aInstance, const otSrpServerHost *aHost)
const otSrpServerHost *
SRP 서버에 등록된 다음 호스트를 반환합니다.
otSrpServerGetPort(otInstance *aInstance)
uint16_t
SRP 서버가 수신하는 포트를 반환합니다.
otSrpServerGetResponseCounters(otInstance *aInstance)
SRP 서버의 응답 카운터를 반환합니다.
otSrpServerGetState(otInstance *aInstance)
SRP 서버의 상태를 반환합니다.
otSrpServerGetTtlConfig(otInstance *aInstance, otSrpServerTtlConfig *aTtlConfig)
void
SRP 서버 TTL 구성을 반환합니다.
otSrpServerHandleServiceUpdateResult(otInstance *aInstance, otSrpServerServiceUpdateId aId, otError aError)
void
SRP 서버에 대한 SRP 업데이트 처리 결과를 보고합니다.
otSrpServerHostGetAddresses(const otSrpServerHost *aHost, uint8_t *aAddressesNum)
const otIp6Address *
지정된 호스트의 주소를 반환합니다.
otSrpServerHostGetFullName(const otSrpServerHost *aHost)
const char *
호스트의 전체 이름을 반환합니다.
otSrpServerHostGetLeaseInfo(const otSrpServerHost *aHost, otSrpServerLeaseInfo *aLeaseInfo)
void
지정된 호스트의 LEASE 및 KEY-LEASE 정보를 반환합니다.
otSrpServerHostGetNextService(const otSrpServerHost *aHost, const otSrpServerService *aService)
지정된 호스트의 다음 서비스를 반환합니다.
otSrpServerHostIsDeleted(const otSrpServerHost *aHost)
bool
SRP 서비스 호스트가 삭제되었는지 알려줍니다.
otSrpServerHostMatchesFullName(const otSrpServerHost *aHost, const char *aFullName)
bool
호스트가 지정된 호스트 이름과 일치하는지 여부를 나타냅니다.
otSrpServerIsAutoEnableMode(otInstance *aInstance)
bool
자동 사용 설정 모드의 사용 설정 여부를 나타냅니다.
otSrpServerParseSubTypeServiceName(const char *aSubTypeServiceName, char *aLabel, uint8_t aLabelSize)
하위 유형 서비스 이름 (전체 이름)을 파싱하고 하위 유형 라벨을 추출합니다.
otSrpServerServiceGetHost(const otSrpServerService *aService)
const otSrpServerHost *
서비스 인스턴스가 있는 호스트를 반환합니다.
otSrpServerServiceGetInstanceLabel(const otSrpServerService *aService)
const char *
서비스의 서비스 인스턴스 라벨 (인스턴스 이름의 첫 번째 라벨)을 반환합니다.
otSrpServerServiceGetInstanceName(const otSrpServerService *aService)
const char *
서비스의 전체 서비스 인스턴스 이름을 반환합니다.
otSrpServerServiceGetLeaseInfo(const otSrpServerService *aService, otSrpServerLeaseInfo *aLeaseInfo)
void
지정된 서비스의 LEASE 및 KEY-LEASE 정보를 반환합니다.
otSrpServerServiceGetNumberOfSubTypes(const otSrpServerService *aService)
uint16_t
서비스의 하위 유형 수를 가져옵니다.
otSrpServerServiceGetPort(const otSrpServerService *aService)
uint16_t
서비스 인스턴스의 포트를 반환합니다.
otSrpServerServiceGetPriority(const otSrpServerService *aService)
uint16_t
서비스 인스턴스의 우선순위를 반환합니다.
otSrpServerServiceGetServiceName(const otSrpServerService *aService)
const char *
서비스의 전체 서비스 이름을 반환합니다.
otSrpServerServiceGetSubTypeServiceNameAt(const otSrpServerService *aService, uint16_t aIndex)
const char *
지정된 색인에서 서비스의 하위 유형 서비스 이름 (전체 이름)을 가져옵니다.
otSrpServerServiceGetTtl(const otSrpServerService *aService)
uint32_t
서비스 인스턴스의 TTL을 반환합니다.
otSrpServerServiceGetTxtData(const otSrpServerService *aService, uint16_t *aDataLength)
const uint8_t *
서비스 인스턴스의 TXT 레코드 데이터를 반환합니다.
otSrpServerServiceGetWeight(const otSrpServerService *aService)
uint16_t
서비스 인스턴스의 가중치를 반환합니다.
otSrpServerServiceHasSubTypeServiceName(const otSrpServerService *aService, const char *aSubTypeServiceName)
bool
서비스에 지정된 하위 유형이 있는지 여부를 나타냅니다.
otSrpServerServiceIsDeleted(const otSrpServerService *aService)
bool
SRP 서비스가 삭제되었는지 여부를 나타냅니다.
otSrpServerServiceMatchesInstanceName(const otSrpServerService *aService, const char *aInstanceName)
bool
이 서비스가 지정된 서비스 인스턴스 이름과 일치하는지 여부를 나타냅니다.
otSrpServerServiceMatchesServiceName(const otSrpServerService *aService, const char *aServiceName)
bool
이 서비스가 지정된 서비스 이름과 일치하는지 여부를 나타냅니다.
otSrpServerSetAddressMode(otInstance *aInstance, otSrpServerAddressMode aMode)
SRP 서버가 사용할 주소 모드를 설정합니다.
otSrpServerSetAnycastModeSequenceNumber(otInstance *aInstance, uint8_t aSequenceNumber)
Anycast 주소 모드에서 사용되는 순서 번호를 설정합니다.
otSrpServerSetAutoEnableMode(otInstance *aInstance, bool aEnabled)
void
SRP 서버에서 자동 사용 설정 모드를 사용 설정/사용 중지합니다.
otSrpServerSetDomain(otInstance *aInstance, const char *aDomain)
SRP 서버에 도메인을 설정합니다.
otSrpServerSetEnabled(otInstance *aInstance, bool aEnabled)
void
SRP 서버를 사용 설정/사용 중지합니다.
otSrpServerSetLeaseConfig(otInstance *aInstance, const otSrpServerLeaseConfig *aLeaseConfig)
SRP 서버 LEASE 및 KEY-LEASE 구성을 설정합니다.
otSrpServerSetServiceUpdateHandler(otInstance *aInstance, otSrpServerServiceUpdateHandler aServiceHandler, void *aContext)
void
SRP 서버에 SRP 서비스 업데이트 핸들러를 설정합니다.
otSrpServerSetTtlConfig(otInstance *aInstance, const otSrpServerTtlConfig *aTtlConfig)
SRP 서버 TTL 구성을 설정합니다.

구조체
otSrpClientBuffersServiceEntry

SRP 클라이언트 서비스 풀 항목을 나타냅니다.

otSrpClientHostInfo

SRP 클라이언트 호스트 정보를 나타냅니다.

otSrpClientService

SRP 클라이언트 서비스를 나타냅니다.

otSrpServerLeaseConfig

SRP 서버 LEASE 및 KEY-LEASE 구성이 포함됩니다.

otSrpServerLeaseInfo

호스트/서비스의 SRP 서버 임대 정보가 포함됩니다.

otSrpServerResponseCounters

SRP 서버 응답 통계가 포함됩니다.

otSrpServerTtlConfig

SRP 서버 TTL 구성이 포함됩니다.

열거형

otSrpClientItemState

 otSrpClientItemState

SRP 클라이언트 항목 (서비스 또는 호스트 정보) 상태를 지정합니다.

속성
OT_SRP_CLIENT_ITEM_STATE_ADDING

항목을 추가/등록하는 중입니다.

OT_SRP_CLIENT_ITEM_STATE_REFRESHING

항목을 새로고침하는 중입니다.

OT_SRP_CLIENT_ITEM_STATE_REGISTERED

항목이 서버에 등록되었습니다.

OT_SRP_CLIENT_ITEM_STATE_REMOVED

항목이 삭제되었습니다.

OT_SRP_CLIENT_ITEM_STATE_REMOVING

항목을 삭제하는 중입니다.

OT_SRP_CLIENT_ITEM_STATE_TO_ADD

추가/등록할 항목입니다.

OT_SRP_CLIENT_ITEM_STATE_TO_REFRESH

새로고침할 항목입니다 (재등록하여 임대를 갱신).

OT_SRP_CLIENT_ITEM_STATE_TO_REMOVE

삭제할 항목입니다.

otSrpServerAddressMode

 otSrpServerAddressMode

SRP 서버가 사용하는 주소 모드를 나타냅니다.

주소 모드는 SRP 서버가 주소 및 포트 번호를 결정하는 방식과 이 정보가 스레드 네트워크 데이터에 게시되는 방식을 지정합니다.

속성
OT_SRP_SERVER_ADDRESS_MODE_ANYCAST

애니캐스트 주소 모드입니다.

OT_SRP_SERVER_ADDRESS_MODE_UNICAST

유니캐스트 주소 모드.

otSrpServerState

 otSrpServerState

SRP 서버의 상태를 나타냅니다.

속성
OT_SRP_SERVER_STATE_DISABLED

SRP 서버가 사용 중지되었습니다.

OT_SRP_SERVER_STATE_RUNNING

SRP 서버가 사용 설정되어 실행 중입니다.

OT_SRP_SERVER_STATE_STOPPED

SRP 서버가 사용 설정되었지만 중지되었습니다.

Typedef

otSrpClientAutoStartCallback

void(* otSrpClientAutoStartCallback)(const otSockAddr *aServerSockAddr, void *aContext)

포인터 유형은 SRP 클라이언트가 자동 시작되거나 중지될 때 사용자에게 알리기 위해 사용하는 콜백을 정의합니다.

자동 시작 기능 OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE가 사용 설정된 경우에만 사용됩니다.

이 콜백은 자동 시작 모드가 사용 설정되고 SRP 클라이언트가 자동으로 시작되거나 중지될 때 호출됩니다.

세부정보
매개변수
[in] aServerSockAddr
NULL이 아닌 포인터는 SRP 서버가 시작되었음을 나타내며 포인터가 선택된 서버 소켓 주소를 제공합니다. NULL 포인터는 SRP 서버가 중지되었음을 나타냅니다.
[in] aContext
임의의 컨텍스트에 대한 포인터입니다 (콜백이 등록된 경우 제공됨).

otSrpClientBuffersServiceEntry

struct otSrpClientBuffersServiceEntry otSrpClientBuffersServiceEntry

SRP 클라이언트 서비스 풀 항목을 나타냅니다.

otSrpClientCallback

void(* otSrpClientCallback)(otError aError, const otSrpClientHostInfo *aHostInfo, const otSrpClientService *aServices, const otSrpClientService *aRemovedServices, void *aContext)

포인터 유형은 SRP 클라이언트에서 사용자에게 변경사항/이벤트/오류를 알리는 데 사용하는 콜백을 정의합니다.

이 콜백은 SRP 서버에 업데이트가 성공적으로 등록될 때(예: 호스트 정보 또는 일부 서비스를 추가/삭제하거나, 실패 또는 오류가 있는 경우(예: 서버가 업데이트 요청을 거부하거나 클라이언트가 응답 대기 중에 타임아웃되는 경우) 호출됩니다.

업데이트를 성공적으로 재등록하는 경우 aError 매개변수는 OT_ERROR_NONE가 되고 호스트 정보와 서비스의 전체 목록이 콜백의 입력 매개변수로 제공됩니다. 호스트 정보와 서비스는 각각 관련 데이터 구조의 상응하는 mState 멤버 변수에서 자체 상태 (호스트 정보/서비스의 등록 또는 삭제 여부 또는 아직 추가/삭제 중인지 등을 나타내는 상태)를 추적합니다.

삭제된 서비스의 목록은 콜백에서 자체 연결 목록 aRemovedServices로 전달됩니다. 콜백이 호출되면 SRP 클라이언트 (OpenThread 구현)는 aRemovedServices에 나열된 삭제된 서비스 인스턴스로 실행되고 더 이상 이를 추적/저장하지 않습니다 (즉, 콜백에서 otSrpClientGetServices()를 호출하는 경우 삭제된 서비스가 반환된 목록에 표시되지 않음). 콜백에서 삭제된 서비스의 별도 목록을 제공하면 사용자에게 이제 삭제된 항목을 표시할 수 있으며, 사용자가 인스턴스의 소유권을 다시 주장/재사용할 수 있습니다.

서버가 SRP 업데이트 요청을 거부하면 DNS 응답 코드 (RFC 2136)가 다음 오류에 매핑됩니다.

  • (0) NOERROR 성공 (오류 조건 없음) -> OT_ERROR_NONE
  • (1) FORMERR 형식 오류로 인해 서버에서 해석할 수 없음 -> OT_ERROR_PARSE
  • (2) SERVFAIL 서버에 내부 오류가 발생했습니다. -> OT_ERROR_FAILED
  • (3) 존재해야 하는 NXDOMAIN 이름(존재하지 않음) -> OT_ERROR_NOT_FOUND
  • (4) NOTIMP 서버가 쿼리 유형을 지원하지 않음 (OpCode) -> OT_ERROR_NOT_IMPLEMENTED
  • (5) 정책/보안상의 이유로 서버에서 거부됨 -> OT_ERROR_SECURITY
  • (6) YXDOMAIN 존재하지 않아야 하는 이름이 있음 -> OT_ERROR_DUPLICATED
  • (7) YXRRSET 존재하지 않아야 하는 일부 RRset -> OT_ERROR_DUPLICATED
  • (8) NXRRSET 존재해야 하지만 존재하지 않는 일부 RRset -> OT_ERROR_NOT_FOUND
  • (9) NOTAUTH 서비스가 영역 -> OT_ERROR_SECURITY에 대한 권한이 아닙니다.
  • (10) NOTZONE A 이름이 영역에 없음 -> OT_ERROR_PARSE
  • (20) BADNAME 잘못된 이름 -> OT_ERROR_PARSE
  • (21) BADALG 알고리즘이 잘못됨 -> OT_ERROR_SECURITY
  • (22) BADTRUN 잘못 잘림 -> OT_ERROR_PARSE
  • 기타 응답 코드 -> OT_ERROR_FAILED

다음과 같은 오류가 발생할 수도 있습니다.

  • OT_ERROR_ADMIN_TIMEOUT : 서버의 응답을 기다리는 동안 시간이 초과되었습니다 (클라이언트에서 계속 재시도함).
  • OT_ERROR_INVALID_ARGS: 제공된 서비스 구조가 잘못되었습니다 (예: 잘못된 서비스 이름 또는 otDnsTxtEntry).
  • OT_ERROR_NO_BUFS : 업데이트 메시지를 준비하거나 전송하기 위한 버퍼가 부족합니다.

오류가 발생할 경우 클라이언트는 작업을 계속합니다. 즉, 일정 대기 간격 후에 SRP 업데이트 메시지를 준비하고 서버에 (재)전송합니다. 재시도 대기 간격은 최솟값부터 시작하여 최댓값까지 실패마다 성장 계수만큼 증가합니다. 자세한 내용은 구성 매개변수 OPENTHREAD_CONFIG_SRP_CLIENT_MIN_RETRY_WAIT_INTERVAL 및 관련 매개변수를 참조하세요.

세부정보
매개변수
[in] aError
오류입니다 (위 참조).
[in] aHostInfo
호스트 정보를 가리키는 포인터입니다.
[in] aServices
모든 서비스 (삭제된 서비스 제외)를 포함하는 연결된 목록의 헤드입니다. 목록이 비어 있으면 NULL입니다.
[in] aRemovedServices
삭제된 모든 서비스가 포함된 연결된 목록의 헤드입니다. 목록이 비어 있으면 NULL입니다.
[in] aContext
임의의 컨텍스트에 대한 포인터입니다 (콜백이 등록된 경우 제공됨).

otSrpClientHostInfo

struct otSrpClientHostInfo otSrpClientHostInfo

SRP 클라이언트 호스트 정보를 나타냅니다.

otSrpClientService

struct otSrpClientService otSrpClientService

SRP 클라이언트 서비스를 나타냅니다.

이름 및 TXT 레코드 항목의 문자열 버퍼를 비롯한 이 구조의 값은 이 구조의 인스턴스가 otSrpClientAddService() 또는 otSrpClientRemoveService()에서 OpenThread로 전달된 후에도 지속되고 일정하게 유지되어야 합니다(MUST).

mState, mData, mNext 필드는 OT 코어에서만 사용/관리됩니다. otSrpClientAddService(), otSrpClientRemoveService() 또는 다른 함수에 otSrpClientService의 인스턴스가 전달되면 해당 값이 무시됩니다. 호출자는 이러한 필드를 설정할 필요가 없습니다.

mLease 및 mKeyLease 필드는 이 서비스에 원하는 임대 및 키 임대 간격을 지정합니다. 값이 0이면 간격이 지정되지 않았으므로 이 서비스에 otSrpClientGetLeaseInterval() 및 otSrpClientGetKeyLeaseInterval()의 기본 임대 또는 키 임대 간격이 사용됩니다. 키 임대 간격 (명시적으로 설정되거나 기본값에서 결정됨)이 서비스의 임대 간격보다 짧은 경우 SRP 클라이언트는 키 임대 간격에도 임대 간격 값을 재사용할 수 있습니다. 예를 들어 서비스에서 mLease가 명시적으로 2일로 설정되고 mKeyLease는 0으로 설정되고 기본 키 임대는 1일로 설정된 경우 이 서비스를 등록할 때 이 서비스에 대해 요청된 키 임대도 2일로 설정됩니다.

otSrpServerAddressMode

enum otSrpServerAddressMode otSrpServerAddressMode

SRP 서버가 사용하는 주소 모드를 나타냅니다.

주소 모드는 SRP 서버가 주소 및 포트 번호를 결정하는 방식과 이 정보가 스레드 네트워크 데이터에 게시되는 방식을 지정합니다.

otSrpServerHost

struct otSrpServerHost otSrpServerHost

이 불투명 유형은 SRP 서비스 호스트를 나타냅니다.

otSrpServerLeaseConfig

struct otSrpServerLeaseConfig otSrpServerLeaseConfig

SRP 서버 LEASE 및 KEY-LEASE 구성이 포함됩니다.

otSrpServerLeaseInfo

struct otSrpServerLeaseInfo otSrpServerLeaseInfo

호스트/서비스의 SRP 서버 임대 정보가 포함됩니다.

otSrpServerResponseCounters

struct otSrpServerResponseCounters otSrpServerResponseCounters

SRP 서버 응답 통계가 포함됩니다.

otSrpServerService

struct otSrpServerService otSrpServerService

이 불투명 유형은 SRP 서비스를 나타냅니다.

otSrpServerServiceUpdateHandler

void(* otSrpServerServiceUpdateHandler)(otSrpServerServiceUpdateId aId, const otSrpServerHost *aHost, uint32_t aTimeout, void *aContext)

SRP 서비스 업데이트를 처리합니다.

SRP 서버에서 호출하여 SRP 호스트 및 가능한 경우 SRP 서비스가 업데이트 중임을 알립니다. 핸들러가 otSrpServerHandleServiceUpdateResult를 호출하여 결과를 반환하거나 aTimeout 후에 타임아웃될 때까지 SRP 업데이트가 커밋되지 않는 것이 중요합니다.

SRP 서비스 관찰자는 업데이트 이벤트를 수신한 직후 오류 코드 OT_ERROR_NONE으로 항상 otSrpServerHandleServiceUpdateResult를 호출해야 합니다.

보다 일반적인 핸들러는 SRP 호스트/서비스에서 유효성 검사를 수행하고 유효성 검사에 실패하면 SRP 업데이트를 거부할 수 있습니다. 예를 들어 광고 프록시는 멀티캐스트 지원 링크의 호스트와 서비스를 광고 (또는 삭제)해야 하며 오류가 발생하는 경우 특정 오류 코드를 반환합니다.

세부정보
매개변수
[in] aId
서비스 업데이트 트랜잭션 ID입니다. 이 ID는 otSrpServerHandleServiceUpdateResult를 사용하여 전달되어야 합니다.
[in] aHost
SRP 업데이트가 포함된 otSrpServerHost 객체에 대한 포인터입니다. 핸들러는 호스트를 게시/게시 취소해야 하며 각 서비스는 아래 규칙에 따라 이 호스트를 가리킵니다.
  1. 호스트가 삭제되지 않은 경우 (otSrpServerHostIsDeleted로 표시됨) mDNS를 사용하여 게시하거나 업데이트해야 합니다. 그 외의 경우에는 호스트가 게시 취소되어야 합니다 (AAAA RR 삭제).
  2. 각 서비스가 이 호스트를 가리키는 경우 호스트를 게시 취소하려면 호스트의 게시를 취소해야 합니다. 그렇지 않은 경우 핸들러는 서비스가 삭제되지 않았을 때 (otSrpServerServiceIsDeleted로 표시됨) 서비스를 게시하거나 업데이트하고 삭제될 때 서비스를 게시 취소해야 합니다.
[in] aTimeout
핸들러가 서비스 이벤트를 처리하는 데 걸리는 최대 시간(밀리초)입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
참고 항목:
otSrpServerSetServiceUpdateHandler
otSrpServerHandleServiceUpdateResult

otSrpServerServiceUpdateId

uint32_t otSrpServerServiceUpdateId

SRP 서버의 SRP 서비스 업데이트 트랜잭션 ID입니다.

otSrpServerTtlConfig

struct otSrpServerTtlConfig otSrpServerTtlConfig

SRP 서버 TTL 구성이 포함됩니다.

함수

otSrpClientAddService

otError otSrpClientAddService(
  otInstance *aInstance,
  otSrpClientService *aService
)

서버에 등록할 서비스를 추가합니다.

이 함수가 성공적으로 호출되면 otSrpClientCallback가 호출되어 SRP 서버에 서비스 추가/등록 상태를 보고합니다.

aService가 가리키는 otSrpClientService 인스턴스는 OT_ERROR_NONE와 함께 이 함수에서 반환된 후에도 지속되고 변경되지 않은 상태로 유지되어야 합니다 (MUST). OpenThread는 포인터를 서비스 인스턴스에 저장합니다.

otSrpClientService 인스턴스는 더 이상 OpenThread에서 추적되지 않으며

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aService
추가할 otSrpClientService 인스턴스를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
서비스 추가가 시작되었습니다. otSrpClientCallback가 호출되어 상태를 보고합니다.
OT_ERROR_ALREADY
서비스 및 인스턴스 이름이 동일한 서비스가 이미 목록에 있습니다.
OT_ERROR_INVALID_ARGS
서비스 구조가 잘못되었습니다 (예: 잘못된 서비스 이름 또는 otDnsTxtEntry).

otSrpClientBuffersAllocateService

otSrpClientBuffersServiceEntry * otSrpClientBuffersAllocateService(
  otInstance *aInstance
)

풀에서 새 서비스 항목을 할당합니다.

반환된 서비스 항목 인스턴스는 다음과 같이 초기화됩니다.

  • mService.mName는 otSrpClientBuffersGetServiceEntryServiceNameString() 함수를 사용하여 가져올 수 있는 할당된 문자열 버퍼를 가리킵니다.
  • mService.mInstanceName는 otSrpClientBuffersGetServiceEntryInstanceNameString() 함수를 사용하여 가져올 수 있는 할당된 문자열 버퍼를 가리킵니다.
  • mService.mSubTypeLabels는 otSrpClientBuffersGetSubTypeLabelsArray()에서 반환된 배열을 가리킵니다.
  • mService.mTxtEntries은(는) mTxtEntry을(를) 가리킵니다.
  • mService.mNumTxtEntries이 1로 설정됩니다.
  • 다른 mService 필드 (포트, 우선순위, 가중치)는 0으로 설정됩니다.
  • mTxtEntry.mKey가 NULL로 설정됩니다 (값이 이미 인코딩된 것으로 처리됨).
  • mTxtEntry.mValue는 할당된 버퍼를 가리키며, 버퍼는 otSrpClientBuffersGetServiceEntryTxtBuffer() 함수를 사용하여 가져올 수 있습니다.
  • mTxtEntry.mValueLength가 0으로 설정됩니다.
  • 모든 관련 데이터/문자열 버퍼 및 배열이 모두 0으로 지워집니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
새로 할당된 서비스 항목을 가리키는 포인터이거나 풀에 더 이상 사용 가능한 항목이 없는 경우 NULL입니다.

otSrpClientBuffersFreeAllServices

void otSrpClientBuffersFreeAllServices(
  otInstance *aInstance
)

이전에 할당된 모든 서비스 항목을 해제합니다.

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

otSrpClientBuffersFreeService

void otSrpClientBuffersFreeService(
  otInstance *aInstance,
  otSrpClientBuffersServiceEntry *aService
)

이전에 할당된 서비스 항목을 해제합니다.

aService는 otSrpClientBuffersAllocateService()를 사용하여 이전에 할당되어야 하며 아직 해제되지 않아야 합니다(MUST). 그렇지 않으면 이 함수의 동작이 정의되지 않습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aService
해제될 서비스 항목의 포인터입니다 (NULL이 아니어야 함).

otSrpClientBuffersGetHostAddressesArray

otIp6Address * otSrpClientBuffersGetHostAddressesArray(
  otInstance *aInstance,
  uint8_t *aArrayLength
)

SRP 클라이언트 호스트 주소 목록으로 사용할 IPv6 주소 항목의 배열을 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[out] aArrayLength
배열 길이, 즉 배열의 IPv6 주소 항목 수를 반환하는 변수에 대한 포인터입니다 (NULL이 아니어야 함).
반환
otIp6Address 항목의 배열에 대한 포인터입니다 (항목 수는 aArrayLength에 반환됨).

otSrpClientBuffersGetHostNameString

char * otSrpClientBuffersGetHostNameString(
  otInstance *aInstance,
  uint16_t *aSize
)

SRP 클라이언트 호스트 이름에 사용할 문자열 버퍼를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[out] aSize
문자열 버퍼의 크기 (바이트 수)를 반환하는 변수에 대한 포인터입니다 (NULL이면 안 됨).
반환
SRP 클라이언트 호스트 이름에 사용할 문자 버퍼에 대한 포인터입니다.

otSrpClientBuffersGetServiceEntryInstanceNameString

char * otSrpClientBuffersGetServiceEntryInstanceNameString(
  otSrpClientBuffersServiceEntry *aEntry,
  uint16_t *aSize
)

서비스 항목에서 서비스 인스턴스 이름의 문자열 버퍼를 가져옵니다.

세부정보
매개변수
[in] aEntry
이전에 할당된 서비스 항목을 가리키는 포인터입니다 (NULL이 아니어야 함).
[out] aSize
문자열 버퍼의 크기 (바이트 수)를 반환하는 변수에 대한 포인터입니다 (NULL이 아니어야 합니다).
반환
문자열 버퍼에 대한 포인터입니다.

otSrpClientBuffersGetServiceEntryServiceNameString

char * otSrpClientBuffersGetServiceEntryServiceNameString(
  otSrpClientBuffersServiceEntry *aEntry,
  uint16_t *aSize
)

서비스 항목에서 서비스 이름의 문자열 버퍼를 가져옵니다.

세부정보
매개변수
[in] aEntry
이전에 할당된 서비스 항목을 가리키는 포인터입니다 (NULL이 아니어야 함).
[out] aSize
문자열 버퍼의 크기 (바이트 수)를 반환하는 변수에 대한 포인터입니다 (NULL이 아니어야 합니다).
반환
문자열 버퍼에 대한 포인터입니다.

otSrpClientBuffersGetServiceEntryTxtBuffer

uint8_t * otSrpClientBuffersGetServiceEntryTxtBuffer(
  otSrpClientBuffersServiceEntry *aEntry,
  uint16_t *aSize
)

서비스 항목에서 TXT 레코드의 버퍼를 가져옵니다.

세부정보
매개변수
[in] aEntry
이전에 할당된 서비스 항목을 가리키는 포인터입니다 (NULL이 아니어야 함).
[out] aSize
버퍼의 크기 (바이트 수)를 반환하는 변수에 대한 포인터입니다 (NULL이 아니어야 함).
반환
버퍼에 대한 포인터입니다.

otSrpClientBuffersGetSubTypeLabelsArray

const char ** otSrpClientBuffersGetSubTypeLabelsArray(
  otSrpClientBuffersServiceEntry *aEntry,
  uint16_t *aArrayLength
)

서비스 항목에서 서비스 하위유형 라벨의 배열을 가져옵니다.

세부정보
매개변수
[in] aEntry
이전에 할당된 서비스 항목을 가리키는 포인터입니다 (NULL이 아니어야 함).
[out] aArrayLength
배열 길이를 반환할 변수에 대한 포인터입니다 (NULL이 아니어야 함).
반환
배열에 대한 포인터입니다.

otSrpClientClearHostAndServices

void otSrpClientClearHostAndServices(
  otInstance *aInstance
)

모든 호스트 정보와 서비스를 지웁니다.

모든 정보를 삭제하기 위해 서버에 업데이트 메시지를 전송하는 otSrpClientRemoveHostAndServices()와 달리 이 함수는 서버와의 상호작용 없이 모든 정보를 즉시 삭제합니다.

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

otSrpClientClearService

otError otSrpClientClearService(
  otInstance *aInstance,
  otSrpClientService *aService
)

서비스를 지우고 클라이언트 서비스 목록에서 즉시 삭제합니다.

서비스를 삭제하기 위해 서버에 업데이트 메시지를 전송하는 otSrpClientRemoveService()와 달리 이 함수는 서버와의 상호작용 없이 클라이언트의 서비스 목록에서 서비스를 삭제합니다. 이 함수 호출에 성공하면 otSrpClientCallback가 호출되지 않고 호출자가 aService 항목을 즉시 회수하여 재사용할 수 있습니다.

후속 otSrpClientAddService() 호출과 함께 사용하여 (동일한 서비스와 인스턴스 이름으로 동일한 aService 항목을 재사용할 수 있음) 기존 서비스의 일부 매개변수를 업데이트할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aService
삭제할 otSrpClientService 인스턴스를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
aService이(가) 삭제되었습니다. 즉시 회수하여 다시 사용할 수 있습니다.
OT_ERROR_NOT_FOUND
목록에서 서비스를 찾을 수 없습니다.

otSrpClientDisableAutoStartMode

void otSrpClientDisableAutoStartMode(
  otInstance *aInstance
)

자동 시작 모드를 사용 중지합니다.

이 기능은 자동 시작 기능 OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE가 사용 설정된 경우에만 사용할 수 있습니다.

자동 시작 모드를 사용 중지해도 클라이언트가 이미 실행 중인 경우에는 중지되지 않지만, 클라이언트가 스레드 네트워크 데이터 모니터링을 중지하여 선택한 SRP 서버가 여전히 존재하는지 확인합니다.

otSrpClientStop()를 호출하면 자동 시작 모드도 사용 중지됩니다.

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

otSrpClientEnableAutoHostAddress

otError otSrpClientEnableAutoHostAddress(
  otInstance *aInstance
)

자동 호스트 주소 모드를 사용 설정합니다.

사용 설정된 경우 모든 링크-로컬 및 메시-로컬 주소를 제외한 스레드 netif의 모든 기본 유니캐스트 주소를 사용하여 SRP 클라이언트에서 호스트 IPv6 주소가 자동으로 설정됩니다. 선호하는 주소가 없는 경우 메시 로컬 EID 주소가 추가됩니다. SRP 클라이언트는 스레드 네트워크에 있는 주소가 업데이트되면 (새 주소가 추가되거나 기존 주소가 삭제되거나 선호되지 않는 것으로 표시됨) 자동으로 재등록됩니다.

자동 호스트 주소 모드는 SRP 클라이언트의 시작 전 또는 작동 중에 사용 설정할 수 있습니다. 단, 호스트 정보가 삭제되는 경우는 예외입니다 (클라이언트가 otSrpClientRemoveHostAndServices() 호출의 삭제 요청을 처리 중이며 호스트 정보가 여전히 STATE_TO_REMOVE 또는 STATE_REMOVING 상태인 경우).

자동 호스트 주소 모드가 사용 설정된 후에는 otSrpClientSetHostAddresses() 호출을 통해 사용 중지할 수 있습니다. 그러면 호스트 주소가 명시적으로 설정됩니다.

세부정보
반환 값
OT_ERROR_NONE
자동 호스트 주소 모드를 사용 설정했습니다.
OT_ERROR_INVALID_STATE
호스트를 삭제하는 중이므로 자동 호스트 주소 모드를 사용 설정할 수 없습니다.

otSrpClientEnableAutoStartMode

void otSrpClientEnableAutoStartMode(
  otInstance *aInstance,
  otSrpClientAutoStartCallback aCallback,
  void *aContext
)

자동 시작 모드를 사용 설정합니다.

이 기능은 자동 시작 기능 OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE가 사용 설정된 경우에만 사용할 수 있습니다.

구성 옵션 OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_DEFAULT_MODE은 기본 자동 시작 모드 (OT 스택 시작 시 사용 설정 또는 사용 중지)를 지정합니다.

자동 시작이 활성화되면 SRP 클라이언트는 스레드 네트워크 데이터를 모니터링하여 SRP 서버를 검색하고 기본 서버를 선택한 다음 SRP 서버가 감지되면 클라이언트를 자동으로 시작 및 중지합니다.

SRP 서버의 존재를 나타내는 네트워크 데이터 항목에는 세 가지 카테고리가 있습니다. 다음 순서로 선호됩니다.

1) 서버 주소가 서비스 데이터에 포함된 기본 유니캐스트 항목. 여러 옵션이 있는 경우 숫자로 된 IPv6 주소가 가장 낮은 옵션이 선호됩니다.

2) 각각 순서 번호를 가진 애니캐스트 항목 RFC-1982의 일련번호 산술 논리로 지정된 의미에서 더 큰 시퀀스 번호가 더 최신으로 간주되므로 선호됩니다. 일련번호 산술 연산을 사용하는 가장 큰 일련번호는 잘 정의된 경우 (즉, 일련번호가 다른 모든 시퀀스 번호보다 큼) 선호됩니다. 잘 정의되지 않은 경우 가장 큰 숫자인 seq 번호가 선호됩니다.

3) 서버 주소 정보가 서버 데이터에 포함된 유니캐스트 항목 여러 옵션이 있는 경우 숫자로 된 IPv6 주소가 가장 낮은 옵션이 선호됩니다.

네트워크 데이터 항목에 변경사항이 있는 경우 클라이언트는 현재 선택된 서버가 네트워크 데이터에 여전히 존재하고 여전히 기본 서버인지 확인합니다. 그렇지 않으면 클라이언트가 새 기본 서버로 전환되거나 아무것도 없는 경우 중지됩니다.

SRP 클라이언트가 성공적인 otSrpClientStart() 호출을 통해 명시적으로 시작되면 otSrpClientStart()의 주어진 SRP 서버 주소는 자동 시작 모드의 상태 및 스레드 네트워크 데이터에서 동일한 SRP 서버 주소가 검색되는지 여부와 관계없이 계속 사용됩니다. 이 경우에는 명시적인 otSrpClientStop() 호출만 클라이언트를 중지합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aCallback
클라이언트가 자동 시작/중지되었을 때 알림을 받을 콜백입니다. 필요하지 않은 경우 NULL일 수 있습니다.
[in] aContext
aCallback를 호출할 때 전달할 컨텍스트입니다.

otSrpClientGetDomainName

const char * otSrpClientGetDomainName(
  otInstance *aInstance
)

SRP 클라이언트에서 사용 중인 도메인 이름을 가져옵니다.

OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE를 사용 설정해야 합니다.

도메인 이름이 설정되지 않은 경우 'default.service.arpa'가 사용됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
도메인 이름 문자열입니다.

otSrpClientGetHostInfo

const otSrpClientHostInfo * otSrpClientGetHostInfo(
  otInstance *aInstance
)

호스트 정보를 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
정보 구조를 호스팅하는 포인터입니다.

otSrpClientGetKeyLeaseInterval

uint32_t otSrpClientGetKeyLeaseInterval(
  otInstance *aInstance
)

SRP 업데이트 요청에 사용되는 기본 키 임대 간격을 가져옵니다.

기본 간격은 mKeyLease가 0으로 설정된 otSrpClientService 인스턴스에만 사용됩니다.

이는 SRP 클라이언트가 요청한 임대 기간입니다. 서버는 다른 임대 간격을 수락할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
키 임대 간격 (초)입니다.

otSrpClientGetLeaseInterval

uint32_t otSrpClientGetLeaseInterval(
  otInstance *aInstance
)

SRP 업데이트 요청에 사용되는 기본 임대 간격을 가져옵니다.

기본 간격은 mLease가 0으로 설정된 otSrpClientService 인스턴스에만 사용됩니다.

이는 SRP 클라이언트가 요청한 임대 기간입니다. 서버는 다른 임대 간격을 수락할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
임대 간격 (초)입니다.

otSrpClientGetServerAddress

const otSockAddr * otSrpClientGetServerAddress(
  otInstance *aInstance
)

SRP 클라이언트가 사용하는 SRP 서버의 소켓 주소 (IPv6 주소 및 포트 번호)를 가져옵니다.

클라이언트가 실행 중이 아닌 경우 포트 번호가 0인 주소가 지정되지 않습니다 (모두 0).

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
SRP 서버의 소켓 주소에 대한 포인터입니다 (항상 NULL이 아님).

otSrpClientGetServices

const otSrpClientService * otSrpClientGetServices(
  otInstance *aInstance
)

클라이언트가 관리하는 서비스의 목록을 가져옵니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
모든 서비스의 연결된 목록의 헤드에 대한 포인터이거나 목록이 비어 있는 경우 NULL입니다.

otSrpClientGetTtl

uint32_t otSrpClientGetTtl(
  otInstance *aInstance
)

SRP 업데이트 요청에 포함된 모든 레코드의 TTL 값을 가져옵니다.

이는 SRP 클라이언트가 요청한 TTL입니다. 서버에서 다른 TTL을 수락할 수 있습니다.

기본적으로 TTL은 임대 간격과 같습니다. 0 또는 otSrpClientSetTtl()를 통해 임대 간격보다 큰 값을 전달하면 TTL이 임대 간격과 같아집니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
TTL (초)입니다.

otSrpClientIsAutoStartModeEnabled

bool otSrpClientIsAutoStartModeEnabled(
  otInstance *aInstance
)

자동 시작 모드의 현재 상태 (사용 설정 또는 사용 중지)를 나타냅니다.

이 기능은 자동 시작 기능 OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE가 사용 설정된 경우에만 사용할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
자동 시작 모드가 활성화된 경우 TRUE, 그렇지 않으면 FALSE입니다.

otSrpClientIsRunning

bool otSrpClientIsRunning(
  otInstance *aInstance
)

SRP 클라이언트가 실행 중인지 여부를 나타냅니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
SRP 클라이언트가 실행 중이면 TRUE, 그렇지 않으면 FALSE입니다.

otSrpClientIsServiceKeyRecordEnabled

bool otSrpClientIsServiceKeyRecordEnabled(
  otInstance *aInstance
)

'서비스 키 레코드 포함' 모드의 사용 설정 여부를 나타냅니다.

OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
'서비스 키 레코드 포함' 모드가 사용 설정되면 TRUE, 사용하지 않으면 FALSE입니다.

otSrpClientItemStateToString

const char * otSrpClientItemStateToString(
  otSrpClientItemState aItemState
)

otSrpClientItemState를 문자열로 변환합니다.

세부정보
매개변수
[in] aItemState
항목 상태입니다.
반환
aItemState의 문자열 표현.

otSrpClientRemoveHostAndServices

otError otSrpClientRemoveHostAndServices(
  otInstance *aInstance,
  bool aRemoveKeyLease,
  bool aSendUnregToServer
)

호스트 정보 및 모든 서비스의 삭제 프로세스를 시작합니다.

이 함수에서 반환된 후 otSrpClientCallback가 호출되어 SRP 서버에 삭제 요청의 상태를 보고합니다.

호스트 정보를 서버에서 영구적으로 삭제하려면 aRemoveKeyLease를 true로 설정해야 합니다. 그러면 서버의 호스트와 연결된 키 임대가 삭제됩니다. 그렇지 않으면 키 임대 레코드가 이전과 동일하게 유지됩니다. 이렇게 하면 클라이언트가 다시 서비스를 제공하고 등록할 수 있을 때를 위해 서버가 호스트 이름을 예약해 둡니다.

aSendUnregToServer는 호스트 정보가 아직 서버에 등록되지 않은 경우의 동작을 결정합니다. aSendUnregToServer가 false (기본값/예상 값)로 설정되면 SRP 클라이언트는 서버에 업데이트 메시지를 보내지 않고 즉시 호스트 정보와 서비스를 삭제합니다 (아직 등록된 서버 항목이 없는 경우 서버를 업데이트할 필요가 없음). aSendUnregToServer가 true로 설정되면 SRP 클라이언트가 서버에 업데이트 메시지를 전송합니다. 호스트 정보가 등록된 경우 aSendUnregToServer 값은 중요하지 않으며 SRP 클라이언트는 항상 모든 정보 삭제를 요청하는 업데이트 메시지를 서버에 전송합니다.

aSendUnregToServer가 유용할 수 있는 상황은 기기 재설정/재부팅 시 호출자가 서버에 이전에 등록된 모든 서비스를 삭제하려고 할 수 있습니다. 이 경우 호출자는 otSrpClientSetHostName()한 다음 aSendUnregToServer를 true로 사용하여 otSrpClientRemoveHostAndServices()를 요청할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aRemoveKeyLease
호스트 키 임대도 제거해야 하는지 여부를 나타내는 불리언입니다.
[in] aSendUnregToServer
호스트 정보가 등록되지 않았을 때 서버에 업데이트를 전송할지 여부를 나타내는 불리언입니다.
반환 값
OT_ERROR_NONE
호스트 정보 및 서비스 삭제가 시작되었습니다. otSrpClientCallback가 호출되어 상태를 보고합니다.
OT_ERROR_ALREADY
호스트 정보가 이미 삭제되었습니다.

otSrpClientRemoveService

otError otSrpClientRemoveService(
  otInstance *aInstance,
  otSrpClientService *aService
)

서비스를 서버에 등록 해제하도록 요청합니다.

이 함수가 성공적으로 호출되면 otSrpClientCallback가 호출되어 SRP 서버에 삭제 요청의 상태를 보고합니다.

aService에서 가리키는 otSrpClientService 인스턴스는 OT_ERROR_NONE와 함께 이 함수에서 반환된 후에도 유지되고 변경되지 않아야 합니다 (MUST). OpenThread는 삭제 프로세스 중에 서비스 인스턴스를 유지합니다. otSrpClientCallback가 호출된 후에만 서비스 인스턴스가 SRP 클라이언트 서비스 목록에서 삭제되고 해제/재사용될 수 있음을 나타냅니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aService
삭제할 otSrpClientService 인스턴스를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
서비스 제거가 시작되었습니다. otSrpClientCallback가 호출되어 상태를 보고합니다.
OT_ERROR_NOT_FOUND
목록에서 서비스를 찾을 수 없습니다.

otSrpClientSetCallback

void otSrpClientSetCallback(
  otInstance *aInstance,
  otSrpClientCallback aCallback,
  void *aContext
)

호출자에게 SRP 클라이언트의 이벤트/변경사항을 알리도록 콜백을 설정합니다.

SRP 클라이언트를 사용하면 단일 콜백을 등록할 수 있습니다. 따라서 이 함수를 연속으로 호출하면 이전에 설정된 콜백 함수를 덮어씁니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aCallback
이벤트 및 변경사항을 알리는 콜백입니다. 필요하지 않은 경우 NULL일 수 있습니다.
[in] aContext
aCallback와 함께 사용되는 임의 컨텍스트입니다.

otSrpClientSetDomainName

otError otSrpClientSetDomainName(
  otInstance *aInstance,
  const char *aName
)

SRP 클라이언트가 사용할 도메인 이름을 설정합니다.

OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE를 사용 설정해야 합니다.

설정하지 않으면 'default.service.arpa'가 사용됩니다.

aName에서 가리키는 이름 문자열 버퍼는 이 함수에서 반환된 후에도 유지되고 변경되지 않아야 합니다(MUST). OpenThread는 문자열 포인터를 유지합니다.

도메인 이름은 클라이언트가 시작되기 전 또는 시작 후, 호스트 정보가 서버에 등록되기 전에 설정할 수 있습니다 (호스트 정보는 STATE_TO_ADD 또는 STATE_TO_REMOVE에 있어야 함).

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aName
도메인 이름 문자열을 가리키는 포인터입니다. NULL은 기본값을 'default.service.arpa'로 설정합니다.
반환 값
OT_ERROR_NONE
도메인 이름 라벨이 설정되었습니다.
OT_ERROR_INVALID_STATE
호스트 정보가 이미 서버에 등록되어 있습니다.

otSrpClientSetHostAddresses

otError otSrpClientSetHostAddresses(
  otInstance *aInstance,
  const otIp6Address *aIp6Addresses,
  uint8_t aNumAddresses
)

호스트 IPv6 주소 목록을 설정/업데이트합니다.

호스트 IPv6 주소는 시작 전 또는 SRP 클라이언트 작업 중에 설정/변경할 수 있습니다(예: 이전에 등록된 호스트 주소를 추가/삭제 또는 변경하기 위해). 단, 클라이언트가 이전 otSrpClientRemoveHostAndServices() 호출의 삭제 요청을 처리 중이며 호스트 정보가 여전히 STATE_TO_REMOVE 또는 STATE_REMOVING 상태에 있는 경우는 예외입니다.

aIp6Addresses에서 가리키는 호스트 IPv6 주소 배열은 이 함수에서 반환된 후에도 유지되고 변경되지 않은 상태로 유지되어야 합니다 (OT_ERROR_NONE 사용). OpenThread는 배열에 대한 포인터를 저장합니다.

이 함수가 성공적으로 호출되면 otSrpClientCallback가 호출되어 SRP 서버에 주소 등록 상태를 보고합니다.

이전에 otSrpClientEnableAutoHostAddress() 호출을 통해 성공하여 자동 호스트 주소 모드가 사용 설정된 경우 이 함수를 호출하면 사용 중지됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aIp6Addresses
호스트 IPv6 주소가 포함된 배열을 가리키는 포인터입니다.
[in] aNumAddresses
aIp6Addresses 배열의 주소 수입니다.
반환 값
OT_ERROR_NONE
호스트 IPv6 주소 목록 변경이 시작되었습니다. otSrpClientCallback는 서버에 주소 등록 상태를 보고하기 위해 호출됩니다.
OT_ERROR_INVALID_ARGS
주소 목록이 잘못되었습니다 (예: 주소가 하나 이상 포함되어야 함).
OT_ERROR_INVALID_STATE
호스트를 삭제하는 중이므로 호스트 주소를 변경할 수 없습니다.

otSrpClientSetHostName

otError otSrpClientSetHostName(
  otInstance *aInstance,
  const char *aName
)

호스트 이름 라벨을 설정합니다.

이 함수가 성공적으로 호출되면 otSrpClientCallback가 호출되어 SRP 서버에 대한 호스트 정보 등록 상태를 보고합니다.

aName에서 가리키는 이름 문자열 버퍼는 이 함수에서 반환된 후에도 유지되고 변경되지 않아야 합니다(MUST). OpenThread는 문자열 포인터를 유지합니다.

호스트 이름은 클라이언트가 시작되기 전 또는 시작 후, 호스트 정보가 서버에 등록되기 전에 설정할 수 있습니다 (호스트 정보는 STATE_TO_ADD 또는 STATE_REMOVED에 있어야 함).

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aName
호스트 이름 라벨 문자열에 대한 포인터입니다 (NULL이면 안 됨). 문자열 버퍼를 가리키는 포인터는 이 함수에서 반환된 후에도 유효하고 일정하게 유지되어야 합니다(MUST).
반환 값
OT_ERROR_NONE
호스트 이름 라벨이 설정되었습니다.
OT_ERROR_INVALID_ARGS
aName가 NULL입니다.
OT_ERROR_INVALID_STATE
호스트 이름이 이미 설정되어 있고 서버에 등록되어 있습니다.

otSrpClientSetKeyLeaseInterval

void otSrpClientSetKeyLeaseInterval(
  otInstance *aInstance,
  uint32_t aInterval
)

SRP 업데이트 요청에 사용되는 기본 키 임대 간격을 설정합니다.

기본 간격은 mKeyLease가 0으로 설정된 otSrpClientService 인스턴스에만 사용됩니다.

임대 간격을 변경해도 이미 등록된 서비스/host-info의 허용되는 임대 간격에는 영향을 미치지 않으며, 향후 SRP 업데이트 메시지 (예: 새 서비스 추가 또는 기존 서비스의 새로고침)에만 영향을 미칩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aInterval
키 임대 간격 (초)입니다. 0이면 OPENTHREAD_CONFIG_SRP_CLIENT_DEFAULT_KEY_LEASE에 의해 지정된 기본값이 사용됩니다.

otSrpClientSetLeaseInterval

void otSrpClientSetLeaseInterval(
  otInstance *aInstance,
  uint32_t aInterval
)

SRP 업데이트 요청에 사용되는 기본 임대 간격을 설정합니다.

기본 간격은 mLease가 0으로 설정된 otSrpClientService 인스턴스에만 사용됩니다.

임대 간격을 변경해도 이미 등록된 서비스/host-info의 허용되는 임대 간격에는 영향을 미치지 않으며, 향후 SRP 업데이트 메시지 (예: 새 서비스 추가 또는 기존 서비스의 새로고침)에만 영향을 미칩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aInterval
임대 간격 (초)입니다. 0이면 OPENTHREAD_CONFIG_SRP_CLIENT_DEFAULT_LEASE에 의해 지정된 기본값이 사용됩니다.

otSrpClientSetServiceKeyRecordEnabled

void otSrpClientSetServiceKeyRecordEnabled(
  otInstance *aInstance,
  bool aEnabled
)

'서비스 키 레코드 포함' 모드를 사용 설정/사용 중지합니다.

사용 설정하면 SRP 클라이언트가 전송하는 SRP 업데이트 메시지의 서비스 설명 안내에 KEY 레코드가 포함됩니다.

OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aEnabled
사용 설정하려면 TRUE, '서비스 키 레코드 포함' 모드를 사용 중지하려면 FALSE입니다.

otSrpClientSetTtl

void otSrpClientSetTtl(
  otInstance *aInstance,
  uint32_t aTtl
)

SRP 업데이트 요청에 포함된 모든 레코드에 TTL 값을 설정합니다.

TTL을 변경해도 이미 등록된 서비스/호스트 정보의 TTL에는 영향을 미치지 않으며, 향후 SRP 업데이트 메시지 (예: 새 서비스 추가 또는 기존 서비스의 새로고침)에만 영향을 미칩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aTtl
TTL (초)입니다. 값이 0이거나 임대 간격보다 크면 TTL이 임대 간격으로 설정됩니다.

otSrpClientStart

otError otSrpClientStart(
  otInstance *aInstance,
  const otSockAddr *aServerSockAddr
)

SRP 클라이언트 작업을 시작합니다.

SRP 클라이언트는 다음 조건이 모두 충족되면 'SRP 업데이트' 메시지를 준비하여 SRP 서버에 전송합니다.

이러한 함수가 호출되는 순서는 중요하지 않습니다. 모든 조건이 충족되면 SRP 클라이언트는 'SRP 업데이트' 메시지를 준비하고 서버로 전송하기 전에 잠시 지연을 기다립니다. 이러한 지연으로 인해 사용자는 첫 번째 SRP 업데이트 메시지가 전송되기 전에 여러 서비스 또는 IPv6 주소를 추가할 수 있습니다 (모든 정보가 포함된 단일 SRP 업데이트가 전송되도록 함). OPENTHREAD_CONFIG_SRP_CLIENT_UPDATE_TX_DELAY 구성은 지연 간격을 지정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aServerSockAddr
SRP 서버의 소켓 주소 (IPv6 주소 및 포트 번호)입니다.
반환 값
OT_ERROR_NONE
SRP 클라이언트 작업이 성공적으로 시작되었거나 이미 동일한 서버 소켓 주소 및 콜백으로 실행 중입니다.
OT_ERROR_BUSY
SRP 클라이언트가 다른 소켓 주소로 실행 중입니다.
OT_ERROR_FAILED
클라이언트의 UDP 소켓을 열거나 연결할 수 없습니다.

otSrpClientStop

void otSrpClientStop(
  otInstance *aInstance
)

SRP 클라이언트 작업을 중지합니다.

SRP 서버와의 추가 상호작용을 중지합니다. 호스트 정보 또는 서비스 목록은 삭제되거나 삭제되지 않습니다. 클라이언트가 (다시) 시작되면 다시 추가/삭제되는 모든 서비스가 표시됩니다.

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

otSrpServerGetAddressMode

otSrpServerAddressMode otSrpServerGetAddressMode(
  otInstance *aInstance
)

SRP 서버가 사용 중인 주소 모드를 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
SRP 서버의 주소 모드

otSrpServerGetAnycastModeSequenceNumber

uint8_t otSrpServerGetAnycastModeSequenceNumber(
  otInstance *aInstance
)

애니캐스트 주소 모드에서 사용된 시퀀스 번호를 반환합니다.

순서 번호는 네트워크 데이터에 게시된 'DNS/SRP Service Anycast Address' 항목에 포함됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
Anycast 시퀀스 번호

otSrpServerGetDomain

const char * otSrpServerGetDomain(
  otInstance *aInstance
)

SRP 서버에 승인된 도메인을 반환합니다.

도메인이 SetDomain에 의해 설정되지 않으면 'default.service.arpa.'가 반환됩니다. 도메인 끝에 마침표가 없는 경우에도 마침표가 항상 추가됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
점으로 조인된 도메인 문자열에 대한 포인터입니다.

otSrpServerGetLeaseConfig

void otSrpServerGetLeaseConfig(
  otInstance *aInstance,
  otSrpServerLeaseConfig *aLeaseConfig
)

SRP 서버 LEASE 및 KEY-LEASE 구성을 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[out] aLeaseConfig
otSrpServerLeaseConfig 인스턴스를 가리키는 포인터입니다.

otSrpServerGetNextHost

const otSrpServerHost * otSrpServerGetNextHost(
  otInstance *aInstance,
  const otSrpServerHost *aHost
)

SRP 서버에 등록된 다음 호스트를 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aHost
현재 호스트를 가리키는 포인터입니다. NULL을 사용하여 첫 번째 호스트를 가져옵니다.
반환
등록된 호스트를 가리키는 포인터입니다. NULL: 더 이상 호스트를 찾을 수 없는 경우

otSrpServerGetPort

uint16_t otSrpServerGetPort(
  otInstance *aInstance
)

SRP 서버가 수신하는 포트를 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
SRP 서버의 포트입니다. 서버가 실행되고 있지 않으면 0을 반환합니다.

otSrpServerGetResponseCounters

const otSrpServerResponseCounters * otSrpServerGetResponseCounters(
  otInstance *aInstance
)

SRP 서버의 응답 카운터를 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
SRP 서버의 응답 카운터에 대한 포인터입니다.

otSrpServerGetState

otSrpServerState otSrpServerGetState(
  otInstance *aInstance
)

SRP 서버의 상태를 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환
SRP 서버의 현재 상태입니다.

otSrpServerGetTtlConfig

void otSrpServerGetTtlConfig(
  otInstance *aInstance,
  otSrpServerTtlConfig *aTtlConfig
)

SRP 서버 TTL 구성을 반환합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[out] aTtlConfig
otSrpServerTtlConfig 인스턴스를 가리키는 포인터입니다.

otSrpServerHandleServiceUpdateResult

void otSrpServerHandleServiceUpdateResult(
  otInstance *aInstance,
  otSrpServerServiceUpdateId aId,
  otError aError
)

SRP 서버에 대한 SRP 업데이트 처리 결과를 보고합니다.

서비스 업데이트 핸들러는 이 함수를 호출하여 SRP 업데이트 처리 결과를 반환해야 합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aId
서비스 업데이트 트랜잭션 ID입니다. otSrpServerServiceUpdateHandler를 통해 제공된 것과 동일한 ID여야 합니다.
[in] aError
SRP 서버에 반환되는 오류입니다. OT_ERROR_DUPLICATED를 사용하여 DNS 이름 충돌을 나타냅니다.

otSrpServerHostGetAddresses

const otIp6Address * otSrpServerHostGetAddresses(
  const otSrpServerHost *aHost,
  uint8_t *aAddressesNum
)

지정된 호스트의 주소를 반환합니다.

세부정보
매개변수
[in] aHost
SRP 서비스 호스트를 가리키는 포인터입니다.
[out] aAddressesNum
주소 수를 출력할 위치를 가리키는 포인터입니다.
반환
IPv6 주소 배열을 가리키는 포인터입니다.

otSrpServerHostGetFullName

const char * otSrpServerHostGetFullName(
  const otSrpServerHost *aHost
)

호스트의 전체 이름을 반환합니다.

세부정보
매개변수
[in] aHost
SRP 서비스 호스트를 가리키는 포인터입니다.
반환
null로 끝나는 호스트 이름 문자열에 대한 포인터입니다.

otSrpServerHostGetLeaseInfo

void otSrpServerHostGetLeaseInfo(
  const otSrpServerHost *aHost,
  otSrpServerLeaseInfo *aLeaseInfo
)

지정된 호스트의 LEASE 및 KEY-LEASE 정보를 반환합니다.

세부정보
매개변수
[in] aHost
SRP 서버 호스트를 가리키는 포인터입니다.
[out] aLeaseInfo
LEASE 및 KEY-LEASE 정보를 출력할 위치에 대한 포인터입니다.

otSrpServerHostGetNextService

const otSrpServerService * otSrpServerHostGetNextService(
  const otSrpServerHost *aHost,
  const otSrpServerService *aService
)

지정된 호스트의 다음 서비스를 반환합니다.

세부정보
매개변수
[in] aHost
SRP 서비스 호스트를 가리키는 포인터입니다.
[in] aService
현재 SRP 서비스 인스턴스에 대한 포인터입니다. NULL을 사용하여 첫 번째 서비스를 가져옵니다.
반환
다음 서비스에 대한 포인터이거나 더 이상 서비스가 없는 경우 NULL입니다.

otSrpServerHostIsDeleted

bool otSrpServerHostIsDeleted(
  const otSrpServerHost *aHost
)

SRP 서비스 호스트가 삭제되었는지 알려줍니다.

SRP 서비스 호스트는 삭제할 수 있지만 나중에 사용할 수 있도록 이름은 유지됩니다. 이 경우 호스트 인스턴스는 SRP 서버/레지스트리에서 삭제되지 않습니다.

세부정보
매개변수
[in] aHost
SRP 서비스 호스트를 가리키는 포인터입니다.
반환
호스트가 삭제되면 TRUE, 삭제되지 않으면 FALSE입니다.

otSrpServerHostMatchesFullName

bool otSrpServerHostMatchesFullName(
  const otSrpServerHost *aHost,
  const char *aFullName
)

호스트가 지정된 호스트 이름과 일치하는지 여부를 나타냅니다.

DNS 이름 일치는 대소문자를 구분하지 않는 문자열 비교 (예: 'Abc'와 'aBc'는 동일한 것으로 간주됩니다.

세부정보
매개변수
[in] aHost
SRP 서비스 호스트를 가리키는 포인터입니다.
[in] aFullName
전체 호스트 이름입니다.
반환 값
TRUE
호스트가 호스트 이름과 일치하는 경우.
FALSE
호스트가 호스트 이름과 일치하지 않는 경우입니다.

otSrpServerIsAutoEnableMode

bool otSrpServerIsAutoEnableMode(
  otInstance *aInstance
)

자동 사용 설정 모드의 사용 설정 여부를 나타냅니다.

OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 기능이 필요합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
반환 값
TRUE
자동 사용 설정 모드가 사용 설정됩니다.
FALSE
자동 사용 설정 모드가 사용 중지됩니다.

otSrpServerParseSubTypeServiceName

otError otSrpServerParseSubTypeServiceName(
  const char *aSubTypeServiceName,
  char *aLabel,
  uint8_t aLabelSize
)

하위 유형 서비스 이름 (전체 이름)을 파싱하고 하위 유형 라벨을 추출합니다.

하위 유형 서비스의 전체 서비스 이름은 '._sub...' 뒤에 옵니다.

세부정보
매개변수
[in] aSubTypeServiceName
하위 유형의 서비스 이름 (전체 이름)입니다.
[out] aLabel
추출된 하위 유형 라벨을 복사하는 버퍼에 대한 포인터입니다.
[in] aLabelSize
aLabel 버퍼의 최대 크기
반환 값
OT_ERROR_NONE
이름이 파싱되었으며 aLabel이(가) 업데이트되었습니다.
OT_ERROR_NO_BUFS
하위 유형 라벨이 aLabel 버퍼에 맞지 않습니다 (라벨이 맞을 수 있는 문자 수를 aLabel에 복사했으므로 null로 끝남).
OT_ERROR_INVALID_ARGS
aSubTypeServiceName은(는) 유효한 하위 유형 형식이 아닙니다.

otSrpServerServiceGetHost

const otSrpServerHost * otSrpServerServiceGetHost(
  const otSrpServerService *aService
)

서비스 인스턴스가 있는 호스트를 반환합니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
반환
호스트 인스턴스를 가리키는 포인터입니다.

otSrpServerServiceGetInstanceLabel

const char * otSrpServerServiceGetInstanceLabel(
  const otSrpServerService *aService
)

서비스의 서비스 인스턴스 라벨 (인스턴스 이름의 첫 번째 라벨)을 반환합니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
반환
null로 종료된 서비스 인스턴스 라벨 문자열에 대한 포인터입니다.

otSrpServerServiceGetInstanceName

const char * otSrpServerServiceGetInstanceName(
  const otSrpServerService *aService
)

서비스의 전체 서비스 인스턴스 이름을 반환합니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
반환
null로 종료된 서비스 인스턴스 이름 문자열에 대한 포인터입니다.

otSrpServerServiceGetLeaseInfo

void otSrpServerServiceGetLeaseInfo(
  const otSrpServerService *aService,
  otSrpServerLeaseInfo *aLeaseInfo
)

지정된 서비스의 LEASE 및 KEY-LEASE 정보를 반환합니다.

세부정보
매개변수
[in] aService
SRP 서버 서비스에 대한 포인터입니다.
[out] aLeaseInfo
LEASE 및 KEY-LEASE 정보를 출력할 위치에 대한 포인터입니다.

otSrpServerServiceGetNumberOfSubTypes

uint16_t otSrpServerServiceGetNumberOfSubTypes(
  const otSrpServerService *aService
)

서비스의 하위 유형 수를 가져옵니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
반환
aService의 하위 유형 수입니다.

otSrpServerServiceGetPort

uint16_t otSrpServerServiceGetPort(
  const otSrpServerService *aService
)

서비스 인스턴스의 포트를 반환합니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
반환
서비스의 포트입니다.

otSrpServerServiceGetPriority

uint16_t otSrpServerServiceGetPriority(
  const otSrpServerService *aService
)

서비스 인스턴스의 우선순위를 반환합니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
반환
서비스의 우선순위입니다.

otSrpServerServiceGetServiceName

const char * otSrpServerServiceGetServiceName(
  const otSrpServerService *aService
)

서비스의 전체 서비스 이름을 반환합니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
반환
null로 종료된 서비스 이름 문자열에 대한 포인터입니다.

otSrpServerServiceGetSubTypeServiceNameAt

const char * otSrpServerServiceGetSubTypeServiceNameAt(
  const otSrpServerService *aService,
  uint16_t aIndex
)

지정된 색인에서 서비스의 하위 유형 서비스 이름 (전체 이름)을 가져옵니다.

하위 유형 서비스의 전체 서비스 이름은 '._sub...' 뒤에 옵니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
[in] aIndex
가져올 색인입니다.
반환
aIndex의 하위 유형 서비스 이름을 가리키는 포인터이거나 이 색인에 하위 유형이 없는 경우 NULL입니다.

otSrpServerServiceGetTtl

uint32_t otSrpServerServiceGetTtl(
  const otSrpServerService *aService
)

서비스 인스턴스의 TTL을 반환합니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
반환
서비스 인스턴스의 TTL입니다.

otSrpServerServiceGetTxtData

const uint8_t * otSrpServerServiceGetTxtData(
  const otSrpServerService *aService,
  uint16_t *aDataLength
)

서비스 인스턴스의 TXT 레코드 데이터를 반환합니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
[out] aDataLength
TXT 레코드 데이터 길이를 반환하는 포인터입니다. NULL이면 안 됩니다(MUST NOT).
반환
TXT 레코드 데이터가 포함된 버퍼를 가리키는 포인터입니다. TXT 데이터 길이는 aDataLength로 반환됩니다.

otSrpServerServiceGetWeight

uint16_t otSrpServerServiceGetWeight(
  const otSrpServerService *aService
)

서비스 인스턴스의 가중치를 반환합니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
반환
서비스의 가중치입니다.

otSrpServerServiceHasSubTypeServiceName

bool otSrpServerServiceHasSubTypeServiceName(
  const otSrpServerService *aService,
  const char *aSubTypeServiceName
)

서비스에 지정된 하위 유형이 있는지 여부를 나타냅니다.

DNS 이름 일치는 대소문자를 구분하지 않는 문자열 비교 (예: 'Abc'와 'aBc'는 동일한 것으로 간주됩니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
[in] aSubTypeServiceName
확인할 하위 유형 서비스 이름 (전체 이름)입니다.
반환 값
TRUE
서비스에는 aSubTypeServiceName 하위 유형이 포함됩니다.
FALSE
서비스에 하위 유형 aSubTypeServiceName이(가) 포함되어 있지 않습니다.

otSrpServerServiceIsDeleted

bool otSrpServerServiceIsDeleted(
  const otSrpServerService *aService
)

SRP 서비스가 삭제되었는지 여부를 나타냅니다.

SRP 서비스는 삭제할 수 있지만 나중에 사용할 수 있도록 이름은 유지됩니다. 이 경우 서비스 인스턴스는 SRP 서버/레지스트리에서 삭제되지 않습니다. 호스트가 삭제되면 모든 서비스도 삭제됩니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
반환
서비스가 삭제되면 TRUE, 삭제되지 않으면 FALSE입니다.

otSrpServerServiceMatchesInstanceName

bool otSrpServerServiceMatchesInstanceName(
  const otSrpServerService *aService,
  const char *aInstanceName
)

이 서비스가 지정된 서비스 인스턴스 이름과 일치하는지 여부를 나타냅니다.

DNS 이름 일치는 대소문자를 구분하지 않는 문자열 비교 (예: 'Abc'와 'aBc'는 동일한 것으로 간주됩니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
[in] aInstanceName
서비스 인스턴스 이름입니다.
반환 값
TRUE
서비스가 서비스 인스턴스 이름과 일치하는 경우
FALSE
서비스가 서비스 인스턴스 이름과 일치하지 않는 경우

otSrpServerServiceMatchesServiceName

bool otSrpServerServiceMatchesServiceName(
  const otSrpServerService *aService,
  const char *aServiceName
)

이 서비스가 지정된 서비스 이름과 일치하는지 여부를 나타냅니다.

DNS 이름 일치는 대소문자를 구분하지 않는 문자열 비교 (예: 'Abc'와 'aBc'는 동일한 것으로 간주됩니다.

세부정보
매개변수
[in] aService
SRP 서비스에 대한 포인터입니다.
[in] aServiceName
서비스 이름입니다.
반환 값
TRUE
서비스가 서비스 이름과 일치하는 경우
FALSE
서비스가 서비스 이름과 일치하지 않는 경우

otSrpServerSetAddressMode

otError otSrpServerSetAddressMode(
  otInstance *aInstance,
  otSrpServerAddressMode aMode
)

SRP 서버가 사용할 주소 모드를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aMode
사용할 주소 모드입니다.
반환 값
OT_ERROR_NONE
주소 모드를 설정했습니다.
OT_ERROR_INVALID_STATE
SRP 서버가 사용 설정되어 주소 모드를 변경할 수 없습니다.

otSrpServerSetAnycastModeSequenceNumber

otError otSrpServerSetAnycastModeSequenceNumber(
  otInstance *aInstance,
  uint8_t aSequenceNumber
)

Anycast 주소 모드에서 사용되는 순서 번호를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aSequenceNumber
사용할 시퀀스 번호입니다.
반환 값
OT_ERROR_NONE
주소 모드를 설정했습니다.
OT_ERROR_INVALID_STATE
SRP 서버가 사용 설정되었으며 순서 번호를 변경할 수 없습니다.

otSrpServerSetAutoEnableMode

void otSrpServerSetAutoEnableMode(
  otInstance *aInstance,
  bool aEnabled
)

SRP 서버에서 자동 사용 설정 모드를 사용 설정/사용 중지합니다.

OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 기능이 필요합니다.

이 모드를 사용하면 Border Routing Manager에서 SRP 서버의 사용 설정/사용 중지 여부를 제어합니다. SRP 서버는 경계 라우팅이 시작되고 초기 접두사 및 경로 구성 (OMR 및 온링크 접두사가 결정되면 인프라 측의 방출된 라우터 광고 메시지에서 공지되고 스레드 네트워크 데이터에 게시됨)으로 자동 사용 설정됩니다. SRP 서버는 BR이 중지되는 경우 (예: 인프라 네트워크 인터페이스가 다운되거나 BR가 분리되는 경우) 자동으로 중지됩니다.

이 모드는 aEnabled가 false로 설정된 otSrpServerSetAutoEnableMode() 호출을 통해 또는 otSrpServerSetEnabled() 함수 호출을 통해 SRP 서버가 명시적으로 사용 설정 또는 사용 중지되는 경우 사용 중지할 수 있습니다. otSrpServerSetAutoEnableMode(false)를 사용하여 자동 사용 설정 모드를 사용 중지해도 SRP 서버의 현재 상태는 변경되지 않습니다. 예를 들어 사용 설정된 경우 사용 설정된 상태로 유지됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aEnabled
자동 사용 설정 모드의 사용 설정/사용 중지에 대한 불리언입니다.

otSrpServerSetDomain

otError otSrpServerSetDomain(
  otInstance *aInstance,
  const char *aDomain
)

SRP 서버에 도메인을 설정합니다.

후행 점이 aDomain에 아직 없으면 추가됩니다. SRP 서버가 사용 설정되기 전에만 호출해야 합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aDomain
설정할 도메인입니다. NULL이면 안 됩니다(MUST NOT).
반환 값
OT_ERROR_NONE
도메인을 aDomain(으)로 설정했습니다.
OT_ERROR_INVALID_STATE
SRP 서버가 이미 사용 설정되어 있으며 도메인을 변경할 수 없습니다.
OT_ERROR_INVALID_ARGS
aDomain 인수는 유효한 DNS 도메인 이름이 아닙니다.
OT_ERROR_NO_BUFS
aDomain의 콘텐츠를 저장할 메모리가 없습니다.

otSrpServerSetEnabled

void otSrpServerSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

SRP 서버를 사용 설정/사용 중지합니다.

보더 라우터에서는 otSrpServerSetAutoEnableMode()를 대신 사용하는 것이 좋습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aEnabled
SRP 서버 사용/사용 중지에 대한 불리언입니다.

otSrpServerSetLeaseConfig

otError otSrpServerSetLeaseConfig(
  otInstance *aInstance,
  const otSrpServerLeaseConfig *aLeaseConfig
)

SRP 서버 LEASE 및 KEY-LEASE 구성을 설정합니다.

클라이언트에서 0이 아닌 LEASE 시간을 요청하면 부여된 값은 [aMinLease, aMaxLease] 범위에서 제한되고 0이 아닌 KEY-LEASE는 [aMinKeyLease, aMaxKeyLease] 범위에서 부여됩니다. 0 LEASE 시간 또는 KEY-LEASE 시간에는 0이 부여됩니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aLeaseConfig
otSrpServerLeaseConfig 인스턴스를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
LEASE 및 KEY-LEASE 범위를 설정했습니다.
OT_ERROR_INVALID_ARGS
LEASE 또는 KEY-LEASE 범위가 올바르지 않습니다.

otSrpServerSetServiceUpdateHandler

void otSrpServerSetServiceUpdateHandler(
  otInstance *aInstance,
  otSrpServerServiceUpdateHandler aServiceHandler,
  void *aContext
)

SRP 서버에 SRP 서비스 업데이트 핸들러를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aServiceHandler
서비스 핸들러를 가리키는 포인터입니다. NULL을 사용하여 핸들러를 제거합니다.
[in] aContext
임의의 컨텍스트 정보에 대한 포인터입니다. 사용하지 않을 경우 NULL일 수 있습니다.

otSrpServerSetTtlConfig

otError otSrpServerSetTtlConfig(
  otInstance *aInstance,
  const otSrpServerTtlConfig *aTtlConfig
)

SRP 서버 TTL 구성을 설정합니다.

부여된 TTL은 최소 및 최대 TTL 구성에 관계없이 항상 otSrpServerSetLeaseConfig()을 통해 구성된 최대 임대 간격 이하여야 합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스를 가리키는 포인터입니다.
[in] aTtlConfig
otSrpServerTtlConfig 인스턴스를 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
TTL 구성을 설정했습니다.
OT_ERROR_INVALID_ARGS
TTL 구성이 잘못되었습니다.

자료

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