github.com/cloudwego/kitex@v0.9.0/pkg/remote/codec.go (about)

     1  /*
     2   * Copyright 2021 CloudWeGo Authors
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * 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  
    17  package remote
    18  
    19  import (
    20  	"context"
    21  )
    22  
    23  // Codec is the abstraction of the codec layer of Kitex.
    24  type Codec interface {
    25  	Encode(ctx context.Context, msg Message, out ByteBuffer) error
    26  	Decode(ctx context.Context, msg Message, in ByteBuffer) error
    27  	Name() string
    28  }
    29  
    30  // MetaEncoder is an abstraction of the encode layer that has meta and payload stage.
    31  // Users could implement EncodeMetaAndPayload to customize header encoding logic,
    32  // or implement EncodePayload and pass the overwritten implementation into EncodeMetaAndPayload
    33  // to customize payload encoding logic.
    34  type MetaEncoder interface {
    35  	EncodeMetaAndPayload(ctx context.Context, msg Message, out ByteBuffer, me MetaEncoder) error
    36  	EncodePayload(ctx context.Context, msg Message, out ByteBuffer) error
    37  }
    38  
    39  // MetaDecoder is an abstraction of the decode layer that has meta and payload stage
    40  type MetaDecoder interface {
    41  	DecodeMeta(ctx context.Context, msg Message, in ByteBuffer) error
    42  	DecodePayload(ctx context.Context, msg Message, in ByteBuffer) error
    43  }