BinaryProcedureEncode (Stringlist subroutine): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (Remove attibute from closing tag(s). More links) |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:BinaryProcedureEncode subtitle}} | {{Template:Stringlist:BinaryProcedureEncode subtitle}} | ||
This method is used to append data in the format used by | This method is used to append data in the format used by <var class="product">[[Janus Web Server]]</var> to store binary data in procedures to a <var>Stringlist</var>. | ||
==Syntax== | ==Syntax== | ||
| Line 12: | Line 12: | ||
<td>The string to be converted to binary procedure format.</td></tr> | <td>The string to be converted to binary procedure format.</td></tr> | ||
<tr><th>base64Flag</th> | <tr><th>base64Flag</th> | ||
<td>A boolean value: if < | <td>A boolean value: if <var class="term">True</var>, the data is to be base64 encoded in the <var>Stringlist</var>, not binary encoded. This is an optional argument, and it defaults to <var class="term">True</var>, which results in base64 encoding.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>All errors in <var>BinaryProcedureEncode</var> result in request cancellation.<li>This method (along with BinaryProcedureDecode) facilitates converting data in a longstring into the format used for storing binary data in procedures by | <ul><li>All errors in <var>BinaryProcedureEncode</var> result in request cancellation.<li>This method (along with the <var>[[BinaryProcedureDecode (Stringlist_function)|BinaryProcedureDecode]]</var> method) facilitates converting data in a longstring into the format used for storing binary data in procedures by <var class="product">[[Janus Web Server]]</var>. This format is necessary if binary data is to be stored in <var class="product">Model 204</var> procedure files because standard procedure formats are not amenable to storing binary data.<li>All data in the binary procedure encoding is wrapped in container data that makes it convenient to store the data in a procedure. By default, the data is also stored in base64 encoding, which represents the data as common displayable characters, making it even more convenient to work with. The convenience of base64 encoding does have a cost, however: it takes four bytes of encoded data to represent three bytes of binary data. In addition, on storage and retrieval, the data must be converted from binary format to base64 encoding and vice versa, which will require some CPU (although probably not a dramatic amount). If the benefits of base64 encoding are determined to not be worth the costs, the second parameter of <var>BinaryProcedureEncode</var> can be set to <var class="term">False</var> to cause the data not to be base64 encoded.<blockquote>The <var>BinaryProcedureDecode</var> method and all other facilities that read the binary procedure encoding format will automatically determine whether the data is base64 encoded or not and do the appropriate decoding.</blockquote><li>The <var>BinaryProcedureEncode</var> method is available in <var class="product">Sirius Mods</var> Version 6.7 and later.</ul> | ||
==Examples== | ==Examples== | ||
The <var>BinaryProcedureEncode</var> method takes data from a longstring and places it on a <var>Stringlist</var>, from which it could then be stored in a procedure. In the following example, a GIF (graphical image) is retrieved from another web server using a | The <var>BinaryProcedureEncode</var> method takes data from a <var>longstring</var> and places it on a <var>Stringlist</var>, from which it could then be stored in a procedure. In the following example, a GIF (graphical image) is retrieved from another web server using a <var class="product">[[Janus Sockets]]</var> HTTP helper request and then moved onto a <var>Stringlist</var> with the special binary procedure encoding: | ||
<p class="code">%req is object httpRequest | <p class="code">%req is object httpRequest | ||
| Line 34: | Line 34: | ||
</p> | </p> | ||
The actual saving of the data to a procedure is not shown, though the example <var>Stringlist</var> could easily be passed to a <var>Daemon</var> object | The actual saving of the data to a procedure is not shown, though the example <var>Stringlist</var> could easily be passed to a <var>Daemon</var> object <var>[[Run (Daemon function)|Run]]</var> method to create the procedure. | ||
[[Category:Stringlist methods|BinaryProcedureEncode function]] | [[Category:Stringlist methods|BinaryProcedureEncode function]] | ||
Revision as of 09:26, 25 January 2011
Convert from binary procedure format to string (Stringlist class)
This method is used to append data in the format used by Janus Web Server to store binary data in procedures to a Stringlist.
Syntax
sl:BinaryProcedureEncode( string, [base64Flag])
Syntax terms
| sl | A Stringlist object. |
|---|---|
| string | The string to be converted to binary procedure format. |
| base64Flag | A boolean value: if True, the data is to be base64 encoded in the Stringlist, not binary encoded. This is an optional argument, and it defaults to True, which results in base64 encoding. |
Usage notes
- All errors in BinaryProcedureEncode result in request cancellation.
- This method (along with the BinaryProcedureDecode method) facilitates converting data in a longstring into the format used for storing binary data in procedures by Janus Web Server. This format is necessary if binary data is to be stored in Model 204 procedure files because standard procedure formats are not amenable to storing binary data.
- All data in the binary procedure encoding is wrapped in container data that makes it convenient to store the data in a procedure. By default, the data is also stored in base64 encoding, which represents the data as common displayable characters, making it even more convenient to work with. The convenience of base64 encoding does have a cost, however: it takes four bytes of encoded data to represent three bytes of binary data. In addition, on storage and retrieval, the data must be converted from binary format to base64 encoding and vice versa, which will require some CPU (although probably not a dramatic amount). If the benefits of base64 encoding are determined to not be worth the costs, the second parameter of BinaryProcedureEncode can be set to False to cause the data not to be base64 encoded.
The BinaryProcedureDecode method and all other facilities that read the binary procedure encoding format will automatically determine whether the data is base64 encoded or not and do the appropriate decoding.
- The BinaryProcedureEncode method is available in Sirius Mods Version 6.7 and later.
Examples
The BinaryProcedureEncode method takes data from a longstring and places it on a Stringlist, from which it could then be stored in a procedure. In the following example, a GIF (graphical image) is retrieved from another web server using a Janus Sockets HTTP helper request and then moved onto a Stringlist with the special binary procedure encoding:
%req is object httpRequest %resp is object httpResponse %gif is longstring %procData is object stringList ... %resp = %req:get %gif = %resp:content(1) %procData = new %procData:add('IN FILE WHATEVER PROCEDURE MUMBLE.GIF') %procData:binaryProcedureEncode(%gif) %procData:add('END PROCEDURE')
The actual saving of the data to a procedure is not shown, though the example Stringlist could easily be passed to a Daemon object Run method to create the procedure.