| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <link rel="canonical" href="https://ignite.apache.org/releases/2.8.1/dotnetdoc/api/Apache.Ignite.Core.Binary.BinaryConfiguration.html" /> |
| <META NAME="ROBOTS" CONTENT="NOINDEX"> |
| |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class BinaryConfiguration |
| | Apache Ignite.NET </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class BinaryConfiguration |
| | Apache Ignite.NET "> |
| <meta name="generator" content="docfx 2.24.0.0"> |
| |
| <link rel="shortcut icon" href="../images/favicon.ico"> |
| <link rel="stylesheet" href="../styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="../styles/docfx.css"> |
| <link rel="stylesheet" href="../styles/main.css"> |
| <meta property="docfx:navrel" content="../toc.html"> |
| <meta property="docfx:tocrel" content="toc.html"> |
| |
| <meta property="docfx:rel" content="../"> |
| |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-61232409-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script></head> |
| <body data-spy="scroll" data-target="#affix"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="../index.html"> |
| <img id="logo" class="svg" src="../images/logo_ignite_32_32.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search" id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"></div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration"> |
| |
| |
| <h1 id="Apache_Ignite_Core_Binary_BinaryConfiguration" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration" class="text-break">Class BinaryConfiguration |
| </h1> |
| <div class="markdown level0 summary"><p>Binary type configuration.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">BinaryConfiguration</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.Binary.html">Apache.Ignite.Core.Binary</a></h6> |
| <h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6> |
| <h5 id="Apache_Ignite_Core_Binary_BinaryConfiguration_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class BinaryConfiguration</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <a id="Apache_Ignite_Core_Binary_BinaryConfiguration__ctor_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.#ctor*"></a> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration__ctor" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.#ctor">BinaryConfiguration()</h4> |
| <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Binary.BinaryConfiguration.html">BinaryConfiguration</a> class.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public BinaryConfiguration()</code></pre> |
| </div> |
| <a id="Apache_Ignite_Core_Binary_BinaryConfiguration__ctor_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.#ctor*"></a> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration__ctor_Apache_Ignite_Core_Binary_BinaryConfiguration_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.#ctor(Apache.Ignite.Core.Binary.BinaryConfiguration)">BinaryConfiguration(BinaryConfiguration)</h4> |
| <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Binary.BinaryConfiguration.html">BinaryConfiguration</a> class.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public BinaryConfiguration(BinaryConfiguration cfg)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Apache.Ignite.Core.Binary.BinaryConfiguration.html">BinaryConfiguration</a></td> |
| <td><span class="parametername">cfg</span></td> |
| <td><p>The binary configuration to copy.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <a id="Apache_Ignite_Core_Binary_BinaryConfiguration__ctor_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.#ctor*"></a> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration__ctor_System_Type___" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.#ctor(System.Type[])">BinaryConfiguration(Type[])</h4> |
| <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Binary.BinaryConfiguration.html">BinaryConfiguration</a> class.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public BinaryConfiguration(params Type[] binaryTypes)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Type</span>[]</td> |
| <td><span class="parametername">binaryTypes</span></td> |
| <td><p>Binary types to register.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="fields">Fields |
| </h3> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration_DefaultCompactFooter" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.DefaultCompactFooter">DefaultCompactFooter</h4> |
| <div class="markdown level1 summary"><p>Default <a class="xref" href="Apache.Ignite.Core.Binary.BinaryConfiguration.html#Apache_Ignite_Core_Binary_BinaryConfiguration_CompactFooter">CompactFooter</a> setting.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const bool DefaultCompactFooter = true</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration_DefaultKeepDeserialized" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.DefaultKeepDeserialized">DefaultKeepDeserialized</h4> |
| <div class="markdown level1 summary"><p>Default <a class="xref" href="Apache.Ignite.Core.Binary.BinaryConfiguration.html#Apache_Ignite_Core_Binary_BinaryConfiguration_KeepDeserialized">KeepDeserialized</a> setting.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const bool DefaultKeepDeserialized = true</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <a id="Apache_Ignite_Core_Binary_BinaryConfiguration_CompactFooter_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.CompactFooter*"></a> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration_CompactFooter" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.CompactFooter">CompactFooter</h4> |
| <div class="markdown level1 summary"><p>Gets or sets a value indicating whether to write footers in compact form. |
| When enabled, Ignite will not write fields metadata when serializing objects, |
| because internally metadata is distributed inside cluster. |
| This increases serialization performance. |
| <p> |
| <strong>WARNING!</strong> This mode should be disabled when already serialized data can be taken from some external |
| sources (e.g.cache store which stores data in binary form, data center replication, etc.). |
| Otherwise binary objects without any associated metadata could could not be deserialized.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public bool CompactFooter { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <a id="Apache_Ignite_Core_Binary_BinaryConfiguration_IdMapper_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.IdMapper*"></a> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration_IdMapper" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.IdMapper">IdMapper</h4> |
| <div class="markdown level1 summary"><p>Default ID mapper.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IBinaryIdMapper IdMapper { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Apache.Ignite.Core.Binary.IBinaryIdMapper.html">IBinaryIdMapper</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <a id="Apache_Ignite_Core_Binary_BinaryConfiguration_KeepDeserialized_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.KeepDeserialized*"></a> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration_KeepDeserialized" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.KeepDeserialized">KeepDeserialized</h4> |
| <div class="markdown level1 summary"><p>Default keep deserialized flag.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public bool KeepDeserialized { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <a id="Apache_Ignite_Core_Binary_BinaryConfiguration_NameMapper_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.NameMapper*"></a> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration_NameMapper" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.NameMapper">NameMapper</h4> |
| <div class="markdown level1 summary"><p>Default name mapper.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IBinaryNameMapper NameMapper { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Apache.Ignite.Core.Binary.IBinaryNameMapper.html">IBinaryNameMapper</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <a id="Apache_Ignite_Core_Binary_BinaryConfiguration_Serializer_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.Serializer*"></a> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration_Serializer" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.Serializer">Serializer</h4> |
| <div class="markdown level1 summary"><p>Default serializer.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IBinarySerializer Serializer { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Apache.Ignite.Core.Binary.IBinarySerializer.html">IBinarySerializer</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <a id="Apache_Ignite_Core_Binary_BinaryConfiguration_TypeConfigurations_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.TypeConfigurations*"></a> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration_TypeConfigurations" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.TypeConfigurations">TypeConfigurations</h4> |
| <div class="markdown level1 summary"><p>Type configurations.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ICollection<BinaryTypeConfiguration> TypeConfigurations { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.ICollection</span><<a class="xref" href="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.html">BinaryTypeConfiguration</a>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <a id="Apache_Ignite_Core_Binary_BinaryConfiguration_Types_" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.Types*"></a> |
| <h4 id="Apache_Ignite_Core_Binary_BinaryConfiguration_Types" data-uid="Apache.Ignite.Core.Binary.BinaryConfiguration.Types">Types</h4> |
| <div class="markdown level1 summary"><p>Gets or sets a collection of assembly-qualified type names |
| (the result of <span class="xref">System.Type.AssemblyQualifiedName</span>) for binarizable types. |
| <p> |
| Shorthand for creating <a class="xref" href="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.html">BinaryTypeConfiguration</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ICollection<string> Types { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.ICollection</span><<span class="xref">System.String</span>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| © 2015 - 2019 The Apache Software Foundation |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="../styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="../styles/docfx.js"></script> |
| <script type="text/javascript" src="../styles/main.js"></script> |
| </body> |
| </html> |
