api

Documentation

Overview

Package api is a generated protocol buffer package.

It is generated from these files:

dfss/dfsst/api/resolution.proto

It has these top-level messages:

AlertRequest
RecoverRequest
TTPResponse

Index

• func RegisterTTPServer(s *grpc.Server, srv TTPServer)
• type AlertRequest
  • func (*AlertRequest) Descriptor() ([]byte, []int)
  • func (m *AlertRequest) GetPromises() []*api2.Promise
  • func (*AlertRequest) ProtoMessage()
  • func (m *AlertRequest) Reset()
  • func (m *AlertRequest) String() string
• type RecoverRequest
  • func (*RecoverRequest) Descriptor() ([]byte, []int)
  • func (*RecoverRequest) ProtoMessage()
  • func (m *RecoverRequest) Reset()
  • func (m *RecoverRequest) String() string
• type TTPClient
  • func NewTTPClient(cc *grpc.ClientConn) TTPClient
• type TTPResponse
  • func (*TTPResponse) Descriptor() ([]byte, []int)
  • func (*TTPResponse) ProtoMessage()
  • func (m *TTPResponse) Reset()
  • func (m *TTPResponse) String() string
• type TTPServer

Functions

func RegisterTTPServer

func RegisterTTPServer(s *grpc.Server, srv TTPServer)

Types

type AlertRequest

type AlertRequest struct {
	// / Promises obtained at this point of the main protocol
	Promises []*api2.Promise `protobuf:"bytes,1,rep,name=promises" json:"promises,omitempty"`
	// / Index at which the alert token was sent
	Index uint32 `protobuf:"varint,2,opt,name=index" json:"index,omitempty"`
}

func (*AlertRequest) Descriptor

func (*AlertRequest) Descriptor() ([]byte, []int)

func (*AlertRequest) GetPromises

func (m *AlertRequest) GetPromises() []*api2.Promise

func (*AlertRequest) ProtoMessage

func (*AlertRequest) ProtoMessage()

func (*AlertRequest) Reset

func (m *AlertRequest) Reset()

func (*AlertRequest) String

func (m *AlertRequest) String() string

type RecoverRequest

type RecoverRequest struct {
	SignatureUUID string `protobuf:"bytes,1,opt,name=signatureUUID" json:"signatureUUID,omitempty"`
}

func (*RecoverRequest) Descriptor

func (*RecoverRequest) Descriptor() ([]byte, []int)

func (*RecoverRequest) ProtoMessage

func (*RecoverRequest) ProtoMessage()

func (*RecoverRequest) Reset

func (m *RecoverRequest) Reset()

func (*RecoverRequest) String

func (m *RecoverRequest) String() string

type TTPClient

type TTPClient interface {
	// / Sent by a client when a signature encounters a problem.
	// Triggers the resolve protocol.
	Alert(ctx context.Context, in *AlertRequest, opts ...grpc.CallOption) (*TTPResponse, error)
	// / Sent by a client after a crash or a self-deconnection.
	// Tries to fetch the result of the resolve protocol, if any.
	Recover(ctx context.Context, in *RecoverRequest, opts ...grpc.CallOption) (*TTPResponse, error)
}

func NewTTPClient

func NewTTPClient(cc *grpc.ClientConn) TTPClient

type TTPResponse

type TTPResponse struct {
	// / True for abort token, False when the TTP was able to generate the fully signed contract
	Abort    bool   `protobuf:"varint,1,opt,name=abort" json:"abort,omitempty"`
	Contract []byte `protobuf:"bytes,2,opt,name=contract,proto3" json:"contract,omitempty"`
}

func (*TTPResponse) Descriptor

func (*TTPResponse) Descriptor() ([]byte, []int)

func (*TTPResponse) ProtoMessage

func (*TTPResponse) ProtoMessage()

func (*TTPResponse) Reset

func (m *TTPResponse) Reset()

func (*TTPResponse) String

func (m *TTPResponse) String() string

type TTPServer

type TTPServer interface {
	// / Sent by a client when a signature encounters a problem.
	// Triggers the resolve protocol.
	Alert(context.Context, *AlertRequest) (*TTPResponse, error)
	// / Sent by a client after a crash or a self-deconnection.
	// Tries to fetch the result of the resolve protocol, if any.
	Recover(context.Context, *RecoverRequest) (*TTPResponse, error)
}