router

Documentation

Overview

Package router provides base router for using in chaincode Invoke function

Index

• Variables
• type Context
• type ContextHandlerFunc
• type ContextMiddlewareFunc
• type ContextResponse
  • func (c ContextResponse) Create(data interface{}, err interface{}) peer.Response
  • func (c ContextResponse) Error(err interface{}) peer.Response
  • func (c ContextResponse) Success(data interface{}) peer.Response
• type ContextState
  • func (s ContextState) Exists(key interface{}) (exists bool, err error)
  • func (s ContextState) Get(key interface{}, target ...interface{}) (result interface{}, err error)
  • func (s ContextState) Insert(key interface{}, value ...interface{}) (err error)
  • func (s ContextState) List(objectType interface{}, target interface{}) (result []interface{}, err error)
  • func (s ContextState) Put(key interface{}, value ...interface{}) (err error)
• type Group
  • func New(name string) *Group
  • func (g *Group) Context(path string, stub shim.ChaincodeStubInterface) Context
  • func (g *Group) ContextHandler(path string, fn ContextHandlerFunc) *Group
  • func (g *Group) Group(path string) *Group
  • func (g *Group) Handle(stub shim.ChaincodeStubInterface) peer.Response
  • func (g *Group) Invoke(path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Group
  • func (g *Group) Query(path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Group
  • func (g *Group) StubHandler(path string, fn StubHandlerFunc) *Group
  • func (g *Group) Use(middleware ...MiddlewareFunc)
• type HandlerFunc
• type InterfaceMap
• type MiddlewareFunc
• type Response
• type State
• type StubHandlerFunc

Variables

var (
	// ErrMethodNotFound occurs when trying to invoke non existent chaincode method
	ErrMethodNotFound = errors.New(`method not found`)
)

Types

type Context

type Context interface {
	Stub() shim.ChaincodeStubInterface
	Client() (cid.ClientIdentity, error)
	Response() Response
	Logger() *shim.ChaincodeLogger
	Path() string
	State() State
	Time() (time.Time, error)
	Args() InterfaceMap
	Arg(string) interface{}
	ArgString(string) string
	ArgBytes(string) []byte
	SetArg(string, interface{})
	Get(string) interface{}
	Set(string, interface{})
	SetEvent(string, interface{}) error
}

Context of chaincode invoke

type ContextHandlerFunc

type ContextHandlerFunc func(Context) peer.Response

ContextHandlerFunc use stub context as input parameter

type ContextMiddlewareFunc

type ContextMiddlewareFunc func(ContextHandlerFunc, ...int) ContextHandlerFunc

ContextMiddlewareFunc middleware for ContextHandlerFun

type ContextResponse

type ContextResponse struct {
	// contains filtered or unexported fields
}

ContextResponse implementation

func (ContextResponse) Create

func (c ContextResponse) Create(data interface{}, err interface{}) peer.Response

Create returns error response if err != nil

func (ContextResponse) Error

func (c ContextResponse) Error(err interface{}) peer.Response

Error response

func (ContextResponse) Success

func (c ContextResponse) Success(data interface{}) peer.Response

Success response

type ContextState

type ContextState struct {
	// contains filtered or unexported fields
}

func (ContextState) Exists

func (s ContextState) Exists(key interface{}) (exists bool, err error)

func (ContextState) Get

func (s ContextState) Get(key interface{}, target ...interface{}) (result interface{}, err error)

func (ContextState) Insert

func (s ContextState) Insert(key interface{}, value ...interface{}) (err error)

func (ContextState) List

func (s ContextState) List(objectType interface{}, target interface{}) (result []interface{}, err error)

func (ContextState) Put

func (s ContextState) Put(key interface{}, value ...interface{}) (err error)

type Group

type Group struct {
	// contains filtered or unexported fields
}

Group of chain code functions

func New

func New(name string) *Group

New group of chain code functions

func (*Group) Context

func (g *Group) Context(path string, stub shim.ChaincodeStubInterface) Context

Context returns chain code invoke context for provided path and stub

func (*Group) ContextHandler

func (g *Group) ContextHandler(path string, fn ContextHandlerFunc) *Group

ContextHandler adds new context handler using presented path

func (*Group) Group

func (g *Group) Group(path string) *Group

Group gets new group using presented path New group can be used as independent

func (*Group) Handle

func (g *Group) Handle(stub shim.ChaincodeStubInterface) peer.Response

Handle used for using in CC Invoke function Must be called after adding new routes using Add function

func (*Group) Invoke

func (g *Group) Invoke(path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Group

Invoke configure handler and middleware functions for chain code function name

func (*Group) Query

func (g *Group) Query(path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Group

Query alias for invoke

func (*Group) StubHandler

func (g *Group) StubHandler(path string, fn StubHandlerFunc) *Group

StubHandler adds new stub handler using presented path

func (*Group) Use

func (g *Group) Use(middleware ...MiddlewareFunc)

Use middleware function in chain code functions group

type HandlerFunc

type HandlerFunc func(Context) (interface{}, error)

HandlerFunc returns result as interface and error, this is converted to peer.Response via response.Create

type InterfaceMap

type InterfaceMap map[string]interface{}

InterfaceMap map of interfaces

type MiddlewareFunc

type MiddlewareFunc func(HandlerFunc, ...int) HandlerFunc

MiddlewareFunc middleware for HandlerFunc

type Response

type Response interface {
	Error(err interface{}) peer.Response
	Success(data interface{}) peer.Response
	Create(data interface{}, err interface{}) peer.Response
}

Response chaincode interface

type State

type State interface {
	Get(key interface{}, target ...interface{}) (result interface{}, err error)
	Exists(key interface{}) (exists bool, err error)
	Put(key interface{}, value ...interface{}) (err error)
	Insert(key interface{}, value ...interface{}) (err error)
	List(objectType interface{}, target interface{}) (result []interface{}, err error)
}

State interface for chain code CRUD operations

type StubHandlerFunc

type StubHandlerFunc func(shim.ChaincodeStubInterface) peer.Response

StubHandlerFunc acts as raw chaincode invoke method, accepts stub and returns peer.Response