com.tencent.angel.common.Serialize Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of angel-ps-core Show documentation

There is a newer version: 3.2.0

/*
 * Tencent is pleased to support the open source community by making Angel available.
 *
 * Copyright (C) 2017-2018 THL A29 Limited, a Tencent company. All rights reserved.
 *
 * 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
 *
 * https://opensource.org/licenses/Apache-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.
 *
 */


package com.tencent.angel.common;

import io.netty.buffer.ByteBuf;

/**
 * Serialize interface. It used by Netty to transfer data.
 */
public interface Serialize {
  /**
   * Serialize object to the Output stream.
   *
   * @param output the Netty ByteBuf
   */
  void serialize(ByteBuf output);

  /**
   * Deserialize object from the input stream.
   *
   * @param input the input stream
   */
  void deserialize(ByteBuf input);

  /**
   * Estimate serialized data size of the object, it used to ByteBuf allocation.
   *
   * @return int serialized data size of the object
   */
  int bufferLen();
}