valuerpc

Documentation

Overview

* * Copyright 2020-present Arpabet Inc. * * 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. *

Index

• Variables
• func NewHandshakeRequest(clientId int64) value.Map
• func NewHandshakeResponse() value.Map
• func ValidMagicAndVersion(req value.Map) bool
• func Verify(args value.Value, def TypeDef) bool
• func VerifyArg(arg value.Value, def ArgDef) bool
• func VerifyArgs(args value.Value, argsDef ArgsDef) bool
• func VerifyParam(value value.Value, def ParamDef) bool
• func VerifyParams(args value.Value, paramsDef ParamsDef) bool
• type AnyDef
  • func (t AnyDef) UserTypeDef()
• type ArgDef
  • func Arg(kind value.Kind, required bool) ArgDef
  • func (t ArgDef) UserTypeDef()
• type ArgsDef
  • func List(args ...ArgDef) ArgsDef
  • func (t ArgsDef) UserTypeDef()
• type MessageType
  • func (t MessageType) Long() value.Number
• type MsgConn
  • func NewMsgConn(conn net.Conn) MsgConn
• type ParamDef
  • func Param(name string, kind value.Kind, required bool) ParamDef
• type ParamsDef
  • func Map(params ...ParamDef) ParamsDef
  • func (t ParamsDef) UserTypeDef()
• type TypeDef
• type VoidDef
  • func (t VoidDef) UserTypeDef()

Variables

var (
	Any  = AnyDef{}
	Void = VoidDef{}

	Bool    = Arg(value.BOOL, true)
	BoolOpt = Arg(value.BOOL, false)

	Number    = Arg(value.NUMBER, true)
	NumberOpt = Arg(value.NUMBER, false)

	String    = Arg(value.STRING, true)
	StringOpt = Arg(value.STRING, false)
)

var ArgumentsField = "args" // allow multiple args if List value in function call

var ClientIdField = "cid"

var ErrorField = "err"

var FunctionNameField = "fn"

var HandshakeRequestId = int64(-1)

var Magic = "vRPC"

var MagicField = "m"

var MessageTypeField = "t"

var RequestIdField = "rid"

var ResultField = "res" // allow multiple results if List in function call

var TimeoutField = "sla"

var ValueField = "val" // streaming value field

var Version = 1.0

var VersionField = "v"

Functions

func NewHandshakeRequest

func NewHandshakeRequest(clientId int64) value.Map

func NewHandshakeResponse

func NewHandshakeResponse() value.Map

func ValidMagicAndVersion

func ValidMagicAndVersion(req value.Map) bool

func Verify

func Verify(args value.Value, def TypeDef) bool

func VerifyArg

func VerifyArg(arg value.Value, def ArgDef) bool

func VerifyArgs

func VerifyArgs(args value.Value, argsDef ArgsDef) bool

func VerifyParam

func VerifyParam(value value.Value, def ParamDef) bool

func VerifyParams

func VerifyParams(args value.Value, paramsDef ParamsDef) bool

Types

type AnyDef

type AnyDef struct {
}

func (AnyDef) UserTypeDef

func (t AnyDef) UserTypeDef()

type ArgDef

type ArgDef struct {
	Kind     value.Kind
	Required bool
}

func Arg

func Arg(kind value.Kind, required bool) ArgDef

func (ArgDef) UserTypeDef

func (t ArgDef) UserTypeDef()

type ArgsDef

type ArgsDef struct {
	List []ArgDef
}

func List

func List(args ...ArgDef) ArgsDef

func (ArgsDef) UserTypeDef

func (t ArgsDef) UserTypeDef()

type MessageType

type MessageType int64

const (
	HandshakeRequest MessageType = iota
	HandshakeResponse
	FunctionRequest
	FunctionResponse
	GetStreamRequest
	PutStreamRequest
	ChatRequest
	ErrorResponse
	StreamReady
	StreamValue
	StreamEnd
	CancelRequest
	ThrottleIncrease
	ThrottleDecrease
)

func (MessageType) Long

func (t MessageType) Long() value.Number

type MsgConn

type MsgConn interface {
	ReadMessage() (value.Map, error)

	WriteMessage(msg value.Map) error

	Close() error

	Conn() net.Conn
}

func NewMsgConn

func NewMsgConn(conn net.Conn) MsgConn

type ParamDef

type ParamDef struct {
	Name     string
	Kind     value.Kind
	Required bool
}

func Param

func Param(name string, kind value.Kind, required bool) ParamDef

type ParamsDef

type ParamsDef struct {
	Map []ParamDef
}

func Map

func Map(params ...ParamDef) ParamsDef

func (ParamsDef) UserTypeDef

func (t ParamsDef) UserTypeDef()

type TypeDef

type TypeDef interface {
	UserTypeDef()
}

type VoidDef

type VoidDef struct {
}

func (VoidDef) UserTypeDef

func (t VoidDef) UserTypeDef()