Protocols/OSCAR/TLV - Revision history

AD: Replaced content with "[https://gitlab.com/hollerith/cool/-/blob/main/docs/protocols/Supplement/TLV/README.md Moved]"

2026-01-17T19:08:59Z

Replaced content with "[https://gitlab.com/hollerith/cool/-/blob/main/docs/protocols/Supplement/TLV/README.md Moved]"

AD at 10:34, 14 February 2021

2021-02-14T10:34:55Z

← Older revision		Revision as of 10:34, 14 February 2021
Line 1,838:		Line 1,838:


			=== From Aleksandr Shutko: Basic OSCAR information: TLV ===
			<table width=640 cellSpacing=0 cellPadding=0 border=0>
			<tr>
			<td>

			<table width=640 bgcolor=darkblue cellSpacing=0 cellPadding=0 border=0><tr><td>
			<table width=100% cellSpacing=2 cellPadding=0 border=0><tr><td bgcolor=#E9E9E9 >
			<table width=100% cellSpacing=0 cellPadding=0 bgcolor="#4040FF" border=0>
			<tr>
			<td><b><font size=2 color="white"> TLV (Type-Length-Value) tuple description </font></b></td>
			</tr>
			</table>
			</td></tr>

			<tr><td bgcolor=#E9E9E9 >
			<table width=100% cellSpacing=0 cellPadding=0 border=0>
			<tr><td width=5> </td>
			<td><br>

			TLVs are a very convenient and efficient method of putting data into an organized
			format, especially variable length strings, etc. TLV literally stands for "Type,
			Length, Value". And that's exactly what it is: a 16bit Type code, a 16bit value
			for the length of the Value field, and then the actual data in the Value field
			(variable length). Here is TLV format:<br><br>

			<table width=100% cellSpacing=0 cellPadding=0 align=center border=0>
			<tr><td width=20></td>
			<td>
			<table width=250 bgcolor=darkgreen cellSpacing=0 cellPadding=0 border=0><tr><td>
			<table width=100% cellSpacing=2 cellPadding=0 border=0><tr><td bgcolor=#fafafa >
			<table width=250 cellSpacing=0 cellPadding=0 align=center border=0>
			<tr>
			<td width=20%> xx xx</td>
			<td width=5> </td>
			<td width=20%>word</td>
			<td width=5> </td>
			<td width=65%>TLV type number</td>
			</tr>
			<tr>
			<td> xx xx</td>
			<td> </td>
			<td>word</td>
			<td> </td>
			<td>TLV length value</td>
			</tr>
			</table>

			</td></tr>
			<tr><td bgcolor=#fafafa >

			<table width=250 cellSpacing=0 cellPadding=0 align=center border=0>
			<tr><td height=8 colspan=3></td></tr>
			<tr><td width=50> </td>
			<td>

			<table width=200 bgcolor=darkred cellSpacing=0 cellPadding=0 border=0><tr><td>
			<table width=100% cellSpacing=2 cellPadding=0 align=center border=0><tr><td bgcolor=#fafafa >

			<table width=200 cellSpacing=0 cellPadding=0 align=center border=0>
			<tr>
			<td height=30 align=center valign=middle> ......</td>
			<td valign=middle width=69%>TLV data</td>
			</tr>
			</table>

			</td></tr>
			</table>
			</td></tr></table>

			</td><td width=5> </td>
			</tr>
			<tr><td height=5 colspan=3> </td></tr>
			</table>

			</td></tr>
			</table>
			</td></tr></table>
			</td></tr>
			</table>

			<br>

			TLVs can be be in SNACs, but that's not required. TLVs often are used directly
			in the FLAP Data Field, but normally are inside of SNACs. More than one
			TLV of each Type code may exist in a single FLAP command (SNAC or not). TLVs
			must follow the strict tuple-rule, or they're really not TLVs, they're raw
			data. One tlv may contain nested tlv chain inside.<br><br>


			TLVs are a big win. They make sending a variable length string like, e.g.,
			"afritz@iname" as simple as defining a TLV with values {0x0011, 0x000c,
			"afritz@iname.com"}. (The type 0x0011 is used throughout the authorization
			process as the "email address type".) A side note about strings: strings in
			this protocol are never NULL-terminated. If they look like they are, that's
			probably a word-length value behind it. <br><br>
			</td>
			<td width=5></td></tr>
			</table>
			</td></tr></table>
			</td></tr></table>
			</td></tr></table>
	[[Category:With_Contrib]]		[[Category:With_Contrib]]



	[[Category:OSCAR]]		[[Category:OSCAR]]

AD at 06:26, 13 February 2021

2021-02-13T06:26:16Z

Show changes

AD at 22:36, 18 March 2020

2020-03-18T22:36:02Z

← Older revision		Revision as of 22:36, 18 March 2020
Line 1:		Line 1:
	{{Protocols/OSCAR}}		{{Protocols/OSCAR}}
			TLVs notes from another
			<!--
			TLVs are a very convenient and efficient method of putting data into an organized format, esp variable length strings, etc. TLV litterally stands for "Type, Length, Value". And that's exactly what it is: a 16bit Type code, a 16bit value for the length of the Value field, and then the actual data in the Value field (variable length).

			TLVs can be be in SNACs, but thats not required. TLVs often are used directly in the FLAP Data Field, but normally are inside of SNACs. No more than one TLV of each Type code may exist in a single FLAP command (SNAC or not). TLVs must follow the strict tuple-rule, or they're really not TLVs, they're raw data.

			TLVs are a big win. They make sending a variable length string like, eg, "afritz@iname" as simple as defining a TLV with values {0x0011, 0x000c, "afritz@iname.com"}. (The type 0x0011 is used throughout the authorization process as the "email address type".) A side note about strings: strings in this protocol are never NULL-terminated. If they look like they are, that's probably a word-length value behind it.
			-->

	TLVs are a very common structure used in the OSCAR protocol to represent dynamically typed data. Parsers should always ignore unknown tags as to not break old clients when new protocol items are added. Possible values for tags are determined by where the TLV is in the protocol; these possible values belong to a TLV class. In the wild, the term type is sometimes used interchangeably with tag, however this document uses tag to reference the integer value associated with the TLV and type as the datatype associated with that tag.		TLVs are a very common structure used in the OSCAR protocol to represent dynamically typed data. Parsers should always ignore unknown tags as to not break old clients when new protocol items are added. Possible values for tags are determined by where the TLV is in the protocol; these possible values belong to a TLV class. In the wild, the term type is sometimes used interchangeably with tag, however this document uses tag to reference the integer value associated with the TLV and type as the datatype associated with that tag.

AD at 04:09, 17 March 2020

2020-03-17T04:09:02Z

← Older revision		Revision as of 04:09, 17 March 2020
Line 9:		Line 9:
	\|-		\|-
	\| Type		\| Type
	\| width="~~100~~" \| uint16 (word)		\| width="95" \| uint16 (word)
	\| Numeric type or "tag" of the data, possible values are defined in the TLV class for the group of TLVs		\| Numeric type or "tag" of the data, possible values are defined in the TLV class for the group of TLVs
	\|-		\|-

AD at 04:07, 17 March 2020

2020-03-17T04:07:02Z

← Older revision		Revision as of 04:07, 17 March 2020
Line 9:		Line 9:
	\|-		\|-
	\| Type		\| Type
	\| width="32" \| uint16 (word)		\| width="100" \| uint16 (word)
	\| Numeric type or "tag" of the data, possible values are defined in the TLV class for the group of TLVs		\| Numeric type or "tag" of the data, possible values are defined in the TLV class for the group of TLVs
	\|-		\|-

AD at 04:06, 17 March 2020

2020-03-17T04:06:43Z

← Older revision		Revision as of 04:06, 17 March 2020
Line 5:		Line 5:
	{\| class="wikitable"		{\| class="wikitable"
	! Name		! Name
	! ~~Type~~		! Size
	! Notes		! Notes
	\|-		\|-
	\| ~~tag~~		\| Type
	\| width="32" \| uint16 (word)		\| width="32" \| uint16 (word)
	\| Numeric tag of the data, possible values are defined in the TLV class for the group of TLVs		\| Numeric type or "tag" of the data, possible values are defined in the TLV class for the group of TLVs
	\|-		\|-
	\| ~~len~~		\| Length
	\| uint16 (word)		\| uint16 (word)
	\| Length in bytes of the variable data		\| Length in bytes of the variable data
	\|-		\|-
	\| ~~value~~		\| Value
	\| blob		\| blob
	\| The data inside the TLV of len length; usually another datatype is used to represent the data - this is described in the TLV class		\| The data inside the TLV of len length; usually another datatype is used to represent the data - this is described in the TLV class

AD at 04:04, 17 March 2020

2020-03-17T04:04:27Z

← Older revision		Revision as of 04:04, 17 March 2020
Line 9:		Line 9:
	\|-		\|-
	\| tag		\| tag
	\| uint16 (word)		\| width="32" \| uint16 (word)
	\| Numeric tag of the data, possible values are defined in the TLV class for the group of TLVs		\| Numeric tag of the data, possible values are defined in the TLV class for the group of TLVs
	\|-		\|-

AD at 04:03, 17 March 2020

2020-03-17T04:03:32Z

← Older revision		Revision as of 04:03, 17 March 2020
Line 9:		Line 9:
	\|-		\|-
	\| tag		\| tag
	\| ~~u16~~		\| uint16 (word)
	\| Numeric tag of the data, possible values are defined in the TLV class for the group of TLVs		\| Numeric tag of the data, possible values are defined in the TLV class for the group of TLVs
	\|-		\|-
	\| len		\| len
	\| ~~u16~~		\| uint16 (word)
	\| Length in bytes of the variable data		\| Length in bytes of the variable data
	\|-		\|-
Line 31:		Line 31:
	\|-		\|-
	\| tlvBlock		\| tlvBlock
	\| ~~u16~~ + data		\| uint16 (word) + data
	\| Two byte number of elements, followed by that many elements		\| Two byte number of elements, followed by that many elements
	\|-		\|-
	\| tlvLBlock		\| tlvLBlock
	\| ~~u16~~ + data		\| uint16 (word) + data
	\| Two byte length of elements, followed by that many bytes of elements		\| Two byte length of elements, followed by that many bytes of elements
	\|}		\|}

	[[Category:OSCAR]]		[[Category:OSCAR]]

AD at 03:29, 17 March 2020

2020-03-17T03:29:29Z

← Older revision		Revision as of 03:29, 17 March 2020
Line 39:		Line 39:
	\|}		\|}

	[[Category::OSCAR]]		[[Category:OSCAR]]