nl::Weave::TLV::TLVReader

현재 바이트 또는 UTF8 문자열 요소의 값을 가져옵니다.

필요한 입력 버퍼 크기를 확인하려면 GetBytes()를 호출하기 전에 GetLength() 메서드를 호출합니다.

TLVReader가 현재 읽고 있는 컨테이너의 유형을 반환합니다.

GetContainerType() 메서드는 TLVReader가 읽고 있는 TLV 컨테이너의 유형을 반환합니다. TLVReader가 TLV 인코딩의 가장 바깥쪽 수준에 배치되는 경우 (즉, 가장 바깥쪽 TLV 요소의 앞, 뒤 또는 뒤) 메서드는 kTLVType_NotSpecified를 반환합니다.

현재 TLV 요소와 연결된 제어 바이트를 반환합니다.

누구도 제어 바이트에 관해 알 필요가 없고 TLV의 내부 구현만 액세스할 수 있는 것이 이상적입니다. 그럼에도 불구하고 제어 바이트에 액세스할 수 있으면 TLV디버그유틸리티 (TLV 버퍼 콘텐츠를 예쁘게 출력할 때 태그 제어 바이트를 디코딩하려고 함)의 디버깅 목적에 유용합니다.

TLV 바이트 또는 UTF8 문자열 요소의 초기 인코딩된 바이트를 가리키는 포인터를 가져옵니다.

이 메서드는 기본 입력 버퍼 내의 인코딩된 문자열 값을 직접 포인터로 반환합니다. 이 메서드가 성공하려면 문자열 값 전체가 단일 버퍼에 있어야 합니다. 그렇지 않으면 메서드가 WEAVE_ERROR_TLV_UNDERRUN을 반환합니다. 따라서 인접하지 않은 여러 버퍼에서 데이터를 읽을 때 메서드의 사용이 제한됩니다.

현재 TLV 요소와 연결된 데이터의 길이를 반환합니다.

데이터 길이는 UTF8 문자열 또는 바이트 문자열 유형의 요소에만 적용됩니다. UTF8 문자열의 경우 반환되는 값은 문자열의 문자 수가 아니라 바이트 수입니다.

판독기가 초기화된 이후 읽은 총 바이트 수를 반환합니다.

기본 입력 버퍼에서 판독기의 현재 위치에 해당하는 지점을 가져옵니다.

최대 읽기 길이에 도달할 때까지 읽을 수 있는 총 바이트 수를 반환합니다.

현재 바이트 또는 UTF8 문자열 요소의 값을 null로 종료된 문자열로 가져옵니다.

필요한 입력 버퍼 크기를 확인하려면 GetBytes()를 호출하기 전에 GetLength() 메서드를 호출합니다. null 문자를 수용하려면 입력 버퍼가 문자열 길이보다 1바이트 이상 커야 합니다.

현재 TLV 요소와 연결된 태그를 반환합니다.

GetTag()에서 반환된 값은 태그 유틸리티 함수 (IsProfileTag(), IsContextTag(), ProfileIdFromTag() 등)와 함께 태그 유형을 확인하고 다양한 태그 필드 값을 추출하는 데 사용할 수 있습니다.

현재 TLV 요소의 유형을 반환합니다.

다른 TLVReader 객체에서 TLVReader 객체를 초기화합니다.

단일 입력 버퍼에서 읽도록 TLVReader 객체를 초기화합니다.

단일 PacketBuffer에서 읽도록 TLVReader 객체를 초기화합니다.

파싱은 버퍼의 시작 위치 (buf->DataStart())에서 시작되어 버퍼의 데이터가 끝날 때까지 (buf->Datalen()으로 표시됨) 또는 maxLen 바이트가 파싱될 때까지 계속됩니다.

하나 이상의 PacketBuffer에서 읽도록 TLVReader 객체를 초기화합니다.

파싱은 초기 버퍼의 시작 위치 (buf->DataStart())에서 시작됩니다. allowDiscontiguousBuffers가 true인 경우 판독기는 Next() 포인터에 의해 연결된 버퍼 체인을 따라 진행합니다. 파싱은 버퍼 체인의 모든 데이터가 소비되거나 (buf->Datalen()으로 표시됨) maxLen 바이트가 파싱될 때까지 계속됩니다.

TLVReader 객체를 읽을 다음 TLV 요소로 진행합니다.

Next() 메서드는 동일한 포함 컨텍스트에 있는 TLV 인코딩의 다음 요소에 판독기 객체를 배치합니다. 특히 판독기가 TLV 인코딩의 가장 바깥쪽 수준에 위치한 경우 Next()를 호출하면 판독기가 다음 최상위 요소로 이동합니다. 판독기가 TLV 컨테이너 요소 (구조, 배열 또는 경로) 내에 위치한 경우 Next()를 호출하면 판독기가 컨테이너의 다음 멤버 요소로 이동합니다.

Next()는 판독기 모션을 현재 포함 컨텍스트로 제한하므로 판독기가 컨테이너 요소에 배치될 때 Next()를 호출하면 컨테이너 위로 이동하고, 컨테이너 이후의 첫 번째 요소에 도달할 때까지 멤버 요소 (및 중첩된 컨테이너의 멤버)를 건너뜁니다.

특정 포함 컨텍스트 내에 추가 요소가 없는 경우 Next() 메서드는 WEAVE_END_OF_TLV 오류를 반환하고 판독기의 위치는 변경되지 않은 상태로 유지됩니다.

TLVReader 객체를 읽을 다음 TLV 요소로 이동하여 새 요소의 유형 및 태그를 어설션합니다.

Next(TLVTypeexpectedType, uint64_t neededTag) 메서드는 Next()와 동작이 같지만 새 TLV 요소의 유형과 태그가 제공된 인수와 일치하는지 확인하는 편의 메서드입니다.

TLV 컨테이너 요소의 멤버를 읽기 위한 새 TLVReader 객체를 초기화합니다.

OpenContainer() 메서드는 TLV 컨테이너의 멤버 요소 (구조, 배열 또는 경로)를 읽기 위한 새 TLVReader 객체를 초기화합니다. OpenContainer()가 호출되면 현재 TLVReader 객체가 읽을 컨테이너 요소에 위치해야 합니다. 이 메서드는 단독 인수로 컨테이너를 읽도록 초기화되는 새 판독기에 대한 참조를 취합니다. 이 판독기는 컨테이너 리더라고 하며, OpenContainer()가 호출되는 판독기는 상위 리더라고 합니다.

OpenContainer() 메서드가 반환되면 컨테이너 리더가 컨테이너의 첫 번째 멤버 바로 앞에 배치됩니다. 컨테이너 리더에서 Next()를 호출하면 끝에 도달할 때까지 컬렉션의 멤버를 진행합니다. 종료 시점에 판독기는 WEAVE_END_OF_TLV를 반환합니다.

컨테이너 리더가 열려 있는 동안 애플리케이션은 상위 리더의 상태를 호출하거나 다른 방식으로 변경해서는 안 됩니다. 애플리케이션에서 컨테이너 리더의 사용이 완료되면 상위 리더에서 CloseContainer()를 호출하고 컨테이너 리더를 인수로 전달하여 컨테이너를 닫아야 합니다. 애플리케이션은 기본 컨테이너에 포함된 모든 요소를 읽거나 읽지 않은 상태에서 언제든지 컨테이너 리더를 닫을 수 있습니다. 컨테이너 리더가 닫힌 후에도 애플리케이션에서 상위 리더를 계속 사용할 수 있습니다.

컨테이너 리더는 상위 리더에서 다양한 구성 속성을 상속합니다. 다음과 같습니다.

• 암시적 프로필 ID (ImplicitProfileId)
• 애플리케이션 데이터 포인터 (AppData)
• GetNextBuffer 함수 포인터

TLVReader 객체를 현재 TLV 요소 바로 뒤로 이동합니다.

Skip() 메서드는 판독기 객체를 현재 TLV 요소 뒤에 배치합니다. 따라서 Next()를 호출하면 판독기가 다음 요소로 이동하게 됩니다. Next()와 마찬가지로 호출 시 컨테이너 요소에 판독기가 배치된 경우 컨테이너의 멤버를 건너뜁니다. 리더가 요소에 배치되지 않은 경우 위치는 변경되지 않습니다.

TVLReader 객체가 TLV 컨테이너의 끝에 있는지 확인합니다.

VerifyEndOfContainer() 메서드는 현재 TLV 컨테이너 내에 더 이상 TLV 요소가 없는지 확인합니다. 이는 Next()를 호출하고 WEAVE_END_OF_TLV의 반환 값을 확인하는 것과 동일한 편의 메서드입니다.

TLVReader의 상태를 지웁니다.

이 방법은 첫 번째 TLV 앞, TLV 사이 또는 마지막 TLV 뒤에 리더를 배치하는 데 사용됩니다.

mControlByte에서 TLVElementType을 반환하는 비공개 메서드입니다.

GetElementHeadLength

WEAVE_ERROR GetElementHeadLength(
  uint8_t & elemHeadBytes
) const 

IsContainerOpen

bool IsContainerOpen(
  void
) const 

WEAVE_ERROR ReadData(
  uint8_t *buf,
  uint32_t len
)

WEAVE_ERROR ReadElement(
  void
)

uint64_t ReadTag(
  TLVTagControl tagControl,
  const uint8_t *& p
)

void SetContainerOpen(
  bool aContainerOpen
)

WEAVE_ERROR SkipData(
  void
)

WEAVE_ERROR SkipToEndOfContainer(
  void
)

WEAVE_ERROR VerifyElement(
  void
)

WEAVE_ERROR FailGetNextBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)

WEAVE_ERROR GetNextPacketBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)