src/csharp/Grpc.Core.Api/SerializationContext.cs

#region Copyright notice and license

// Copyright 2018 The gRPC Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#endregion

using System;
using System.Buffers;

namespace Grpc.Core
{
    /// <summary>
    /// Provides storage for payload when serializing a message.
    /// </summary>
    public abstract class SerializationContext
    {
        /// <summary>
        /// Use the byte array as serialized form of current message and mark serialization process as complete.
        /// <c>Complete(byte[])</c> can only be called once. By calling this method the caller gives up the ownership of the
        /// payload which must not be accessed afterwards.
        /// </summary>
        /// <param name="payload">the serialized form of current message</param>
        public virtual void Complete(byte[] payload)
        {
            throw new NotImplementedException();
        }

        /// <summary>
        /// Gets buffer writer that can be used to write the serialized data. Once serialization is finished,
        /// <c>Complete()</c> needs to be called.
        /// </summary>
        public virtual IBufferWriter<byte> GetBufferWriter()
        {
            throw new NotImplementedException();
        }

        /// <summary>
        /// Sets the payload length when writing serialized data into a buffer writer. If the serializer knows the full payload
        /// length in advance, providing that information before obtaining the buffer writer using <c>GetBufferWriter()</c> can improve
        /// serialization efficiency by avoiding copies. The provided payload length must be the same as the data written to the writer.
        /// Calling this method is optional. If the payload length is not set then the length is calculated using the data written to
        /// the buffer writer when <c>Complete()</c> is called.
        /// </summary>
        /// <param name="payloadLength">The total length of the payload in bytes.</param>
        public virtual void SetPayloadLength(int payloadLength)
        {
        }

        /// <summary>
        /// Complete the payload written to the buffer writer. <c>Complete()</c> can only be called once.
        /// </summary>
        public virtual void Complete()
        {
            throw new NotImplementedException();
        }
    }
}