ceph/src/arrow/csharp/src/Apache.Arrow/Ipc/IpcOptions.cs

   1 // Licensed to the Apache Software Foundation (ASF) under one or more
   2 // contributor license agreements. See the NOTICE file distributed with
   3 // this work for additional information regarding copyright ownership.
   4 // The ASF licenses this file to You under the Apache License, Version 2.0
   5 // (the "License"); you may not use this file except in compliance with
   6 // the License.  You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15
  16 namespace Apache.Arrow.Ipc
  17 {
  18     public class IpcOptions
  19     {
  20         internal static IpcOptions Default { get; } = new IpcOptions();
  21
  22         /// <summary>
  23         /// Write the pre-0.15.0 encapsulated IPC message format
  24         /// consisting of a 4-byte prefix instead of 8 byte.
  25         /// </summary>
  26         public bool WriteLegacyIpcFormat { get; set; }
  27
  28         public IpcOptions()
  29         {
  30         }
  31
  32         /// <summary>
  33         /// Gets the number of bytes used in the IPC message prefix.
  34         /// </summary>
  35         internal int SizeOfIpcLength => WriteLegacyIpcFormat ? 4 : 8;
  36     }
  37 }