/usr/share/doc/polyorb-doc/html/polyorb_ug/Character-data-Converter.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This is free software; you can redistribute it and/or modify it under
terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.  This software is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License and
a copy of the GCC Runtime Library Exception along with this program;
see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
<http://www.gnu.org/licenses/>. -->
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>PolyORB User&rsquo;s Guide: Character data Converter</title>

<meta name="description" content="PolyORB User&rsquo;s Guide: Character data Converter">
<meta name="keywords" content="PolyORB User&rsquo;s Guide: Character data Converter">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="About-This-Guide.html#About-This-Guide" rel="start" title="About This Guide">
<link href="Index.html#Index" rel="index" title="Index">
<link href="About-This-Guide.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Code-sets.html#Code-sets" rel="up" title="Code sets">
<link href="Converters-factories.html#Converters-factories" rel="next" title="Converters factories">
<link href="Adding-support-for-new-code-sets.html#Adding-support-for-new-code-sets" rel="prev" title="Adding support for new code sets">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Character-data-Converter"></a>
<div class="header">
<p>
Next: <a href="Converters-factories.html#Converters-factories" accesskey="n" rel="next">Converters factories</a>, Previous: <a href="Adding-support-for-new-code-sets.html#Adding-support-for-new-code-sets" accesskey="p" rel="prev">Adding support for new code sets</a>, Up: <a href="Code-sets.html#Code-sets" accesskey="u" rel="up">Code sets</a> &nbsp; [<a href="About-This-Guide.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Character-data-Converter-1"></a>
<h4 class="subsection">10.4.4 Character data Converter</h4>

<p>Character data converters do direct marshalling/unmarshalling of
character data (char or wchar - depending on <code>Converter</code>)
into/from PolyORB&rsquo;s buffer. This allows to minimize the speed penalty on
character data marshalling.
</p>
<p>Character data Converters for char data have the following API (from
<samp>PolyORB.GIOP_P.Code_Sets.Converters</samp> package:
</p>
<div class="smallexample">
<pre class="smallexample">   type Converter is abstract tagged private;

   procedure Marshall
     (C      : Converter;
      Buffer : access Buffers.Buffer_Type;
      Data   : Types.Char;
      Error  : in out Errors.Error_Container)
      is abstract;

   procedure Marshall
     (C      : Converter;
      Buffer : access Buffers.Buffer_Type;
      Data   : Types.String;
      Error  : in out Errors.Error_Container)
      is abstract;

   procedure Unmarshall
     (C      : Converter;
      Buffer : access Buffers.Buffer_Type;
      Data   :    out Types.Char;
      Error  : in out Errors.Error_Container)
      is abstract;

   procedure Unmarshall
     (C      : Converter;
      Buffer : access Buffers.Buffer_Type;
      Data   :    out Types.String;
      Error  : in out Errors.Error_Container)
      is abstract;
</pre></div>

<p>The Marshall subprograms do marshalling of one character or string of
characters into the buffer. The Unmarshall subprograms do unmarshalling
of one character or string of characters from the buffer.
</p>
<p><i>Note: Depending on the item size of the data (char/wchar) and GIOP
version, marshalling/unmarshalling algorithms may vary. In some
situations marshalling of string is not equivalent to marshalling its
length and marshalling one by one each character. Please refere to GIOP
specifications for more details.</i>
</p>
<p>If marshalling/unmarshalling fails, subprograms must set the Error
parameter to the corresponding error, usually <code>Data_Conversion_E</code>.
</p>
<p><i>Note: We recommend to always use the Data_Conversion_E error code
with Minor status 1.</i>
</p>
<p>All <code>Converters</code> (native, fallback and conversion) have similar
APIs.  Wchar data converters differ only in parameter type.
</p>



</body>
</html>
polyorb-doc 2.11~20140418-3 / usr / share / doc / polyorb-doc / html / polyorb_ug / Character-data-Converter.html
