Documentation ¶
Overview ¶
* Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You 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.
Index ¶
- Constants
- Variables
- func GetSerializerById(id byte) (interface{}, error)
- func LoadSerializer(p *DubboPackage) error
- func SetSerializer(name string, serializer interface{})
- func ToMapStringInterface(origin map[interface{}]interface{}) map[string]interface{}
- type DubboHeader
- type DubboPackage
- func (p DubboPackage) GetBody() interface{}
- func (p DubboPackage) GetBodyLen() int
- func (p DubboPackage) GetHeader() DubboHeader
- func (p DubboPackage) GetLen() int
- func (p DubboPackage) GetService() Service
- func (p DubboPackage) IsHeartBeat() bool
- func (p DubboPackage) IsRequest() bool
- func (p DubboPackage) IsResponse() bool
- func (p DubboPackage) IsResponseWithException() bool
- func (p *DubboPackage) Marshal() (*bytes.Buffer, error)
- func (p *DubboPackage) ReadHeader() error
- func (p *DubboPackage) SetBody(body interface{})
- func (p *DubboPackage) SetHeader(header DubboHeader)
- func (p *DubboPackage) SetID(id int64)
- func (p *DubboPackage) SetResponseStatus(status byte)
- func (p *DubboPackage) SetSerializer(serializer Serializer)
- func (p *DubboPackage) SetService(svc Service)
- func (p DubboPackage) String() string
- func (p *DubboPackage) Unmarshal() error
- type HessianSerializer
- type Object
- type PackageType
- type ProtocolCodec
- type RequestPayload
- type ResponsePayload
- type Serializer
- type Service
Constants ¶
const ( TAG_READ = int32(-1) ASCII_GAP = 32 CHUNK_SIZE = 4096 BC_BINARY = byte('B') // final chunk BC_BINARY_CHUNK = byte('A') // non-final chunk BC_BINARY_DIRECT = byte(0x20) // 1-byte length binary BINARY_DIRECT_MAX = byte(0x0f) BC_BINARY_SHORT = byte(0x34) // 2-byte length binary BINARY_SHORT_MAX = 0x3ff // 0-1023 binary BC_DATE = byte(0x4a) // 64-bit millisecond UTC date BC_DATE_MINUTE = byte(0x4b) // 32-bit minute UTC date BC_DOUBLE = byte('D') // IEEE 64-bit double BC_DOUBLE_ZERO = byte(0x5b) BC_DOUBLE_ONE = byte(0x5c) BC_DOUBLE_BYTE = byte(0x5d) BC_DOUBLE_SHORT = byte(0x5e) BC_DOUBLE_MILL = byte(0x5f) BC_FALSE = byte('F') // boolean false BC_INT = byte('I') // 32-bit int INT_DIRECT_MIN = -0x10 INT_DIRECT_MAX = byte(0x2f) BC_INT_ZERO = byte(0x90) INT_BYTE_MIN = -0x800 INT_BYTE_MAX = 0x7ff BC_INT_BYTE_ZERO = byte(0xc8) BC_END = byte('Z') INT_SHORT_MIN = -0x40000 INT_SHORT_MAX = 0x3ffff BC_INT_SHORT_ZERO = byte(0xd4) BC_LIST_VARIABLE = byte(0x55) BC_LIST_FIXED = byte('V') BC_LIST_VARIABLE_UNTYPED = byte(0x57) BC_LIST_FIXED_UNTYPED = byte(0x58) BC_LIST_DIRECT = byte(0x70) BC_LIST_DIRECT_UNTYPED = byte(0x78) LIST_DIRECT_MAX = byte(0x7) BC_LONG = byte('L') // 64-bit signed integer LONG_DIRECT_MIN = -0x08 LONG_DIRECT_MAX = byte(0x0f) BC_LONG_ZERO = byte(0xe0) LONG_BYTE_MIN = -0x800 LONG_BYTE_MAX = 0x7ff BC_LONG_BYTE_ZERO = byte(0xf8) LONG_SHORT_MIN = -0x40000 LONG_SHORT_MAX = 0x3ffff BC_LONG_SHORT_ZERO = byte(0x3c) BC_LONG_INT = byte(0x59) BC_MAP = byte('M') BC_MAP_UNTYPED = byte('H') BC_NULL = byte('N') // x4e BC_OBJECT = byte('O') BC_OBJECT_DEF = byte('C') BC_OBJECT_DIRECT = byte(0x60) OBJECT_DIRECT_MAX = byte(0x0f) BC_REF = byte(0x51) BC_STRING = byte('S') // final string BC_STRING_CHUNK = byte('R') // non-final string BC_STRING_DIRECT = byte(0x00) STRING_DIRECT_MAX = byte(0x1f) BC_STRING_SHORT = byte(0x30) STRING_SHORT_MAX = 0x3ff BC_TRUE = byte('T') P_PACKET_CHUNK = byte(0x4f) P_PACKET = byte('P') P_PACKET_DIRECT = byte(0x80) PACKET_DIRECT_MAX = byte(0x7f) P_PACKET_SHORT = byte(0x70) PACKET_SHORT_MAX = 0xfff ARRAY_STRING = "[string" ARRAY_INT = "[int" ARRAY_DOUBLE = "[double" ARRAY_FLOAT = "[float" ARRAY_BOOL = "[boolean" ARRAY_LONG = "[long" PATH_KEY = "path" GROUP_KEY = "group" INTERFACE_KEY = "interface" VERSION_KEY = "version" TIMEOUT_KEY = "timeout" STRING_NIL = "" STRING_TRUE = "true" STRING_FALSE = "false" STRING_ZERO = "0.0" STRING_ONE = "1.0" )
constansts
const ( Response_OK byte = 20 Response_CLIENT_TIMEOUT byte = 30 Response_SERVER_TIMEOUT byte = 31 Response_BAD_REQUEST byte = 40 Response_BAD_RESPONSE byte = 50 Response_SERVICE_NOT_FOUND byte = 60 Response_SERVICE_ERROR byte = 70 Response_SERVER_ERROR byte = 80 Response_CLIENT_ERROR byte = 90 // According to "java dubbo" There are two cases of response: // 1. with attachments // 2. no attachments RESPONSE_WITH_EXCEPTION int32 = 0 RESPONSE_VALUE int32 = 1 RESPONSE_NULL_VALUE int32 = 2 RESPONSE_WITH_EXCEPTION_WITH_ATTACHMENTS int32 = 3 RESPONSE_VALUE_WITH_ATTACHMENTS int32 = 4 RESPONSE_NULL_VALUE_WITH_ATTACHMENTS int32 = 5 )
ResponsePayload related consts
const ( // header length. HEADER_LENGTH = 16 // magic header MAGIC = uint16(0xdabb) MAGIC_HIGH = byte(0xda) MAGIC_LOW = byte(0xbb) // message flag. FLAG_REQUEST = byte(0x80) FLAG_TWOWAY = byte(0x40) FLAG_EVENT = byte(0x20) // for heartbeat SERIAL_MASK = 0x1f DUBBO_VERSION = "2.5.4" DUBBO_VERSION_KEY = "dubbo" DEFAULT_DUBBO_PROTOCOL_VERSION = "2.0.2" // Dubbo RPC protocol version, for compatibility, it must not be between 2.0.10 ~ 2.6.2 LOWEST_VERSION_FOR_RESPONSE_ATTACHMENT = 2000200 DEFAULT_LEN = 8388608 // 8 * 1024 * 1024 default body max length )
*
- the dubbo protocol header length is 16 Bytes.
- the first 2 Bytes is magic code '0xdabb'
- the next 1 Byte is message flags, in which its 16-20 bit is serial id, 21 for event, 22 for two way, 23 for request/response flag
- the next 1 Bytes is response state.
- the next 8 Bytes is package DI.
- the next 4 Bytes is package length. *
const ( JAVA_IDENT_REGEX = "(?:[_$a-zA-Z][_$a-zA-Z0-9]*)" CLASS_DESC = "(?:L" + JAVA_IDENT_REGEX + "(?:\\/" + JAVA_IDENT_REGEX + ")*;)" ARRAY_DESC = "(?:\\[+(?:(?:[VZBCDFIJS])|" + CLASS_DESC + "))" DESC_REGEX = "(?:(?:[VZBCDFIJS])|" + CLASS_DESC + "|" + ARRAY_DESC + ")" )
regular
const ( PackageError = PackageType(0x01) PackageRequest = PackageType(0x02) PackageResponse = PackageType(0x04) PackageHeartbeat = PackageType(0x08) PackageRequest_TwoWay = PackageType(0x10) PackageResponse_Exception = PackageType(0x20) PackageType_BitSize = 0x2f )
enum part
const (
DUBBO = "dubbo"
)
const ( // Zero : byte zero Zero = byte(0x00) )
Variables ¶
var ( DubboRequestHeaderBytesTwoWay = [HEADER_LENGTH]byte{MAGIC_HIGH, MAGIC_LOW, FLAG_REQUEST | FLAG_TWOWAY} DubboRequestHeaderBytes = [HEADER_LENGTH]byte{MAGIC_HIGH, MAGIC_LOW, FLAG_REQUEST} DubboResponseHeaderBytes = [HEADER_LENGTH]byte{MAGIC_HIGH, MAGIC_LOW, Zero, Response_OK} DubboRequestHeartbeatHeader = [HEADER_LENGTH]byte{MAGIC_HIGH, MAGIC_LOW, FLAG_REQUEST | FLAG_TWOWAY | FLAG_EVENT} DubboResponseHeartbeatHeader = [HEADER_LENGTH]byte{MAGIC_HIGH, MAGIC_LOW, FLAG_EVENT} )
Dubbo request response related consts
var ( ErrHeaderNotEnough = errors.New("header buffer too short") ErrBodyNotEnough = errors.New("body buffer too short") ErrJavaException = errors.New("got java exception") ErrIllegalPackage = errors.New("illegal package!") )
Error part
var ( DubboVersionKey = "dubboVersion" ArgsTypesKey = "argsTypes" ArgsKey = "args" ServiceKey = "service" AttachmentsKey = "attachments" )
Body map keys
var DescRegex, _ = regexp.Compile(DESC_REGEX)
DescRegex ...
Functions ¶
func GetSerializerById ¶
func LoadSerializer ¶
func LoadSerializer(p *DubboPackage) error
func SetSerializer ¶
func SetSerializer(name string, serializer interface{})
func ToMapStringInterface ¶
func ToMapStringInterface(origin map[interface{}]interface{}) map[string]interface{}
Types ¶
type DubboHeader ¶
type DubboHeader struct { SerialID byte Type PackageType ID int64 BodyLen int ResponseStatus byte }
type DubboPackage ¶
type DubboPackage struct { Header DubboHeader Service Service Body interface{} Err error Codec *ProtocolCodec }
func NewDubboPackage ¶
func NewDubboPackage(data *bytes.Buffer) *DubboPackage
func (DubboPackage) GetBody ¶
func (p DubboPackage) GetBody() interface{}
func (DubboPackage) GetBodyLen ¶
func (p DubboPackage) GetBodyLen() int
func (DubboPackage) GetHeader ¶
func (p DubboPackage) GetHeader() DubboHeader
func (DubboPackage) GetLen ¶
func (p DubboPackage) GetLen() int
func (DubboPackage) GetService ¶
func (p DubboPackage) GetService() Service
func (DubboPackage) IsHeartBeat ¶
func (p DubboPackage) IsHeartBeat() bool
func (DubboPackage) IsRequest ¶
func (p DubboPackage) IsRequest() bool
func (DubboPackage) IsResponse ¶
func (p DubboPackage) IsResponse() bool
func (DubboPackage) IsResponseWithException ¶
func (p DubboPackage) IsResponseWithException() bool
func (*DubboPackage) ReadHeader ¶
func (p *DubboPackage) ReadHeader() error
func (*DubboPackage) SetBody ¶
func (p *DubboPackage) SetBody(body interface{})
func (*DubboPackage) SetHeader ¶
func (p *DubboPackage) SetHeader(header DubboHeader)
func (*DubboPackage) SetID ¶
func (p *DubboPackage) SetID(id int64)
func (*DubboPackage) SetResponseStatus ¶
func (p *DubboPackage) SetResponseStatus(status byte)
func (*DubboPackage) SetSerializer ¶
func (p *DubboPackage) SetSerializer(serializer Serializer)
func (*DubboPackage) SetService ¶
func (p *DubboPackage) SetService(svc Service)
func (DubboPackage) String ¶
func (p DubboPackage) String() string
func (*DubboPackage) Unmarshal ¶
func (p *DubboPackage) Unmarshal() error
type HessianSerializer ¶
type HessianSerializer struct { }
func (HessianSerializer) Marshal ¶
func (h HessianSerializer) Marshal(p DubboPackage) ([]byte, error)
func (HessianSerializer) Unmarshal ¶
func (h HessianSerializer) Unmarshal(input []byte, p *DubboPackage) error
type PackageType ¶
type PackageType int
type ProtocolCodec ¶
type ProtocolCodec struct {
// contains filtered or unexported fields
}
func NewDubboCodec ¶
func NewDubboCodec(reader *bufio.Reader) *ProtocolCodec
func (*ProtocolCodec) Decode ¶
func (c *ProtocolCodec) Decode(p *DubboPackage) error
func (*ProtocolCodec) Encode ¶
func (c *ProtocolCodec) Encode(p DubboPackage) ([]byte, error)
func (*ProtocolCodec) EncodeHeader ¶
func (c *ProtocolCodec) EncodeHeader(p DubboPackage) []byte
func (*ProtocolCodec) ReadHeader ¶
func (c *ProtocolCodec) ReadHeader(header *DubboHeader) error
func (*ProtocolCodec) SetSerializer ¶
func (c *ProtocolCodec) SetSerializer(serializer Serializer)
type RequestPayload ¶
type RequestPayload struct { Params interface{} Attachments map[string]interface{} }
func EnsureRequestPayload ¶
func EnsureRequestPayload(body interface{}) *RequestPayload
func NewRequestPayload ¶
func NewRequestPayload(args interface{}, atta map[string]interface{}) *RequestPayload
type ResponsePayload ¶
type ResponsePayload struct { RspObj interface{} Exception error Attachments map[string]interface{} }
func EnsureResponsePayload ¶
func EnsureResponsePayload(body interface{}) *ResponsePayload
func NewResponsePayload ¶
func NewResponsePayload(rspObj interface{}, exception error, attachments map[string]interface{}) *ResponsePayload
NewResponse create a new ResponsePayload
type Serializer ¶
type Serializer interface { Marshal(p DubboPackage) ([]byte, error) Unmarshal([]byte, *DubboPackage) error }