nl :: Dệt :: TLV :: TLVReader

Nhận giá trị của byte hiện tại hoặc phần tử chuỗi UTF8.

Để xác định kích thước bộ đệm đầu vào cần thiết, hãy gọi getLength () phương pháp trước khi gọi getBytes () .

Trả về loại container trong đó cácTLVReader hiện đang đọc.

Các GetContainerType () phương thức trả về kiểu của TLV chứa trong đó cácTLVReader đang đọc. NếuTLVReader được đặt ở mức outer-nhất của một TLV mã hóa (tức là trước đó, vào ngày hoặc sau nhất bên ngoài-the TLV phần tử), phương pháp này sẽ trở lại kTLVType_NotSpecified.

Trả về byte kiểm soát kết hợp với hiện tại TLV phần tử.

Lý tưởng nhất, không ai cần biết về byte kiểm soát và chỉ việc thực hiện nội bộ của TLV nên có quyền truy cập vào nó. Nhưng, tuy nhiên, có quyền truy cập vào các byte điều khiển là hữu ích cho mục đích gỡ lỗi bởi TLV gỡ lỗi Utilities (mà cố gắng để giải mã các byte kiểm soát thẻ khi khá in TLV đệm nội dung).

Nhận một con trỏ đến byte được mã hóa ban đầu của một TLV byte hoặc thành phần chuỗi UTF8.

Phương thức này trả về một con trỏ trực tiếp giá trị chuỗi được mã hóa trong bộ đệm đầu vào bên dưới. Để thành công, phương thức yêu cầu toàn bộ giá trị chuỗi phải có trong một bộ đệm duy nhất. Nếu phương thức trả về WEAVE_ERROR_TLV_UNDERRUN . Điều này làm cho phương pháp được sử dụng hạn chế khi đọc dữ liệu từ nhiều bộ đệm không liên tục.

Trả về chiều dài của dữ liệu liên quan đến hiện tại TLV phần tử.

Độ dài dữ liệu chỉ áp dụng cho các phần tử của kiểu chuỗi UTF8 hoặc chuỗi byte. Đối với chuỗi UTF8, giá trị trả về là số byte trong chuỗi, không phải số ký tự.

Trả về tổng số byte đã đọc kể từ khi trình đọc được khởi tạo.

Lấy điểm trong bộ đệm đầu vào bên dưới tương ứng với vị trí hiện tại của đầu đọc.

Trả về tổng số byte có thể đọc được cho đến khi đạt đến độ dài đọc tối đa.

Nhận giá trị của byte hiện tại hoặc phần tử chuỗi UTF8 dưới dạng chuỗi kết thúc bằng null.

Để xác định kích thước bộ đệm đầu vào cần thiết, hãy gọi getLength () phương pháp trước khi gọi getBytes () . Bộ đệm đầu vào phải lớn hơn độ dài chuỗi ít nhất một byte để chứa ký tự null.

Trả thẻ được kết hợp với hiện tại TLV phần tử.

Giá trị trả về bởi GetTag () có thể được sử dụng với các chức năng thẻ tiện ích ( IsProfileTag () , IsContextTag () , ProfileIdFromTag () , vv) để xác định các loại thẻ và để trích xuất giá trị trường thẻ khác nhau.

Trả về loại của dòng điện TLV phần tử.

Khởi mộtTLVReader đối tượng từ mộtTLVReader đối tượng.

Khởi mộtTLVReader đối tượng để đọc từ một bộ đệm đầu vào duy nhất.

Khởi mộtTLVReader đối tượng để đọc từ một PacketBuffer duy nhất.

Quá trình phân tích cú pháp bắt đầu từ vị trí bắt đầu của bộ đệm (buf-> DataStart ()) và tiếp tục cho đến khi kết thúc dữ liệu trong bộ đệm (như được biểu thị bằng buf-> Datalen ()) hoặc các byte maxLen đã được phân tích cú pháp.

Khởi mộtTLVReader đối tượng để đọc từ một hoặc nhiều PacketBuffers.

Quá trình phân tích cú pháp bắt đầu từ vị trí bắt đầu của bộ đệm ban đầu (buf-> DataStart ()). Nếu allowDiscontiguousBuffers là đúng, người đọc sẽ thúc đẩy thông qua các chuỗi bộ đệm được liên kết bởi họ () Tiếp theo gợi ý. Việc phân tích cú pháp tiếp tục cho đến khi tất cả dữ liệu trong chuỗi bộ đệm đã được sử dụng (như được biểu thị bằng buf-> Datalen ()) hoặc các byte maxLen đã được phân tích cú pháp.

Tiến cácTLVReader đối tượng tiếp theo TLV yếu tố để được đọc.

Các Next () vị trí phương pháp đối tượng độc giả trên phần tử tiếp theo trong một TLV mã hóa cư trú rằng trong bối cảnh kiềm chế tương tự. Đặc biệt, nếu người đọc là vị trí ở cấp ngoài-nhất của một TLV mã hóa, kêu gọi tiếp theo () sẽ thúc đẩy người đọc vào, phần tử tiếp theo ở trên cùng. Nếu người đọc được định vị trong một TLV yếu tố container (một cấu trúc, mảng hoặc đường dẫn), kêu gọi tiếp theo () sẽ thúc đẩy người đọc đến các yếu tố thành viên tiếp theo của container.

Kể từ Next () làm hạn chế người đọc chuyển động với bối cảnh ngăn chặn hiện, kêu gọi tiếp theo () khi người đọc được định vị trên một yếu tố container sẽ tiến so với container, bỏ qua các yếu tố thành viên của nó (và các thành viên của bất kỳ container lồng nhau) cho đến khi nó đạt đến đầu tiên phần tử sau vùng chứa.

Khi không có các yếu tố hơn nữa trong một bối cảnh ngăn chặn đặc biệt là Tiếp () phương pháp sẽ trả về một WEAVE_END_OF_TLV lỗi và vị trí của người đọc sẽ không thay đổi.

Tiến cácTLVReader đối tượng tiếp theo TLV yếu tố để được đọc, khẳng định loại và thẻ của phần tử mới.

Các Next (TLVType expectedType, uint64_t expectedTag) phương pháp là một phương pháp thuận tiện có hành vi tương tự như sau () , nhưng cũng xác nhận rằng các loại và thẻ của mới TLV yếu tố phù hợp với các đối số cung cấp.

Khởi mớiTLVReader đối tượng cho việc đọc các thành viên của TLV yếu tố container.

Các OpenContainer () phương pháp khởi tạo một mớiTLVReader đối tượng cho việc đọc các yếu tố thành viên của một TLV container (một cấu trúc, mảng hoặc đường dẫn). Khi OpenContainer () được gọi, hiện tạiTLVReader đối tượng phải được đặt trên các yếu tố container để được đọc. Phương thức coi như đối số duy nhất của nó là một tham chiếu đến một trình đọc mới sẽ được khởi tạo để đọc vùng chứa. Đọc này được biết đến như người đọc thùng trong khi người đọc mà OpenContainer () được gọi là được biết đến như người đọc mẹ.

Khi OpenContainer () trở về phương pháp, người đọc container được vị trí ngay trước khi thành viên đầu tiên của container. Gọi Tiếp () vào người đọc container sẽ thúc đẩy thông qua các thành viên của bộ sưu tập cho đến khi cuối cùng đã đạt được, lúc này người đọc sẽ trở WEAVE_END_OF_TLV.

Trong khi trình đọc vùng chứa đang mở, các ứng dụng không được thực hiện lệnh gọi hoặc thay đổi trạng thái của trình đọc chính. Khi một ứng dụng đã hoàn thành bằng cách sử dụng đầu đọc chứa nó phải đóng nó lại bằng cách gọi CloseContainer () trên đầu đọc phụ huynh, thông qua người đọc container như một cuộc tranh cãi. Các ứng dụng có thể đóng trình đọc vùng chứa tại bất kỳ thời điểm nào, có hoặc không đọc tất cả các phần tử có trong vùng chứa bên dưới. Sau khi đóng trình đọc vùng chứa, các ứng dụng có thể tiếp tục sử dụng trình đọc cha.

Trình đọc vùng chứa kế thừa các thuộc tính cấu hình khác nhau từ trình đọc cha. Đó là:

• Id hồ sơ ngầm định (ImplicitProfileId)
• Con trỏ dữ liệu ứng dụng (AppData)
• Con trỏ hàm GetNextBuffer

Tiến bộTLVReader đối tượng ngay sau khi dòng điện TLV phần tử.

The Skip() method positions the reader object immediately after the current TLV element, such that a subsequent call to Next() will advance the reader to the following element. Like Next() , if the reader is positioned on a container element at the time of the call, the members of the container will be skipped. If the reader is not positioned on any element, its position remains unchanged.

Verifies that the TVLReader object is at the end of a TLV container.

The VerifyEndOfContainer() method verifies that there are no further TLV elements to be read within the current TLV container. This is a convenience method that is equivalent to calling Next() and checking for a return value of WEAVE_END_OF_TLV.

Clear the state of theTLVReader .

This method is used to position the reader before the first TLV , between TLVs or after the last TLV .

This is a private method that returns the TLVElementType from mControlByte.

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
)