Skip to content

Commit

Permalink
add well-known content parameter section to describe byteSeq
Browse files Browse the repository at this point in the history
  • Loading branch information
relu91 committed Jun 8, 2022
1 parent 69390f5 commit c610eba
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,9 @@ <h3>Payload Representation</h3>
<ul>
<li>
<b>Media Types:</b> Media Types [[IANA-MEDIA-TYPES]] describe the encoding used for sending and
receiving the data with a protocol.
receiving the data with a protocol. They are commonly composed by two parts separated by a slash:
type/subtype. The type is a string that identifies a general category like <code>text</code>, or
<code>image</code>, whereas the subtype is a string that identifies the specific data type used.
They are represented with the <code>contentType</code> in the Forms of a TD, which is mandatory for
each Interaction Affordance.
In some cases such as images, videos or any unstructured data, they are enough to describe the
Expand Down Expand Up @@ -376,6 +378,25 @@ <h3>Payload Representation</h3>
</tr>
</tbody>
</table>

<section>
<h4>Wellknown Media Types parameters</h4>

<p>
Other than a type and subtype, Media Types might contain parameters [[IANA-MEDIA-TYPES]]. These parameters are
specified in the form of a key value pair separated by an equal sign (e.g. <code>text/html;charset=utf-8</code>).
This section describes a set of wellknown parameters in the context of the Web of Things.
</p>
<ul>
<li>
<b>byteSeq</b>: The byte sequence parameter indicates the endianness of the raw payload with media type
<code>application/octet-stream</code>. The accepted values are <code>BIG_ENDIAN</code> (default value),
<code>BIG_ENDIAN</code>, <code>BIG_ENDIAN_BYTE_SWAP</code>, and <code>LITTLE_ENDIAN_BYTE_SWAP</code>.
The <b>byteSeq</b> parameter is useful in protocols that does not have a native endianness definition
and different nodes adopt one or another depending on the host platform.
</li>
</ul>
</section>

<section>
<h4>Creating a new Payload Format Binding</h4>
Expand Down

0 comments on commit c610eba

Please sign in to comment.