pb

README

News service gRPC contract

This directory contains the news.proto file that defines the gRPC contract of the news service. Whenever you change it run the following commands:

protoc news.proto --go_out=plugins=grpc:.
python -m grpc_tools.protoc -I. --python_out=. --grpc_python_out=. news.proto

The first command generates news.pb.go that the news service imports.

The second command generates two Python modules for Python consumers of the service.

Documentation

Index

• Variables
• func RegisterNewsServer(s *grpc.Server, srv NewsServer)
• type Event
  • func (*Event) Descriptor() ([]byte, []int)
  • func (m *Event) GetEventType() EventType
  • func (m *Event) GetTimestamp() *timestamp.Timestamp
  • func (m *Event) GetUrl() string
  • func (m *Event) GetUsername() string
  • func (*Event) ProtoMessage()
  • func (m *Event) Reset()
  • func (m *Event) String() string
  • func (m *Event) XXX_DiscardUnknown()
  • func (m *Event) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *Event) XXX_Merge(src proto.Message)
  • func (m *Event) XXX_Size() int
  • func (m *Event) XXX_Unmarshal(b []byte) error
• type EventType
  • func (EventType) EnumDescriptor() ([]byte, []int)
  • func (x EventType) String() string
• type GetNewsRequest
  • func (*GetNewsRequest) Descriptor() ([]byte, []int)
  • func (m *GetNewsRequest) GetStartToken() string
  • func (m *GetNewsRequest) GetUsername() string
  • func (*GetNewsRequest) ProtoMessage()
  • func (m *GetNewsRequest) Reset()
  • func (m *GetNewsRequest) String() string
  • func (m *GetNewsRequest) XXX_DiscardUnknown()
  • func (m *GetNewsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *GetNewsRequest) XXX_Merge(src proto.Message)
  • func (m *GetNewsRequest) XXX_Size() int
  • func (m *GetNewsRequest) XXX_Unmarshal(b []byte) error
• type GetNewsResponse
  • func (*GetNewsResponse) Descriptor() ([]byte, []int)
  • func (m *GetNewsResponse) GetErr() string
  • func (m *GetNewsResponse) GetEvents() []*Event
  • func (m *GetNewsResponse) GetNextToken() string
  • func (*GetNewsResponse) ProtoMessage()
  • func (m *GetNewsResponse) Reset()
  • func (m *GetNewsResponse) String() string
  • func (m *GetNewsResponse) XXX_DiscardUnknown()
  • func (m *GetNewsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *GetNewsResponse) XXX_Merge(src proto.Message)
  • func (m *GetNewsResponse) XXX_Size() int
  • func (m *GetNewsResponse) XXX_Unmarshal(b []byte) error
• type NewsClient
  • func NewNewsClient(cc *grpc.ClientConn) NewsClient
• type NewsServer

Variables

var EventType_name = map[int32]string{
	0: "LINK_ADDED",
	1: "LINK_UPDATED",
	2: "LINK_DELETED",
}

var EventType_value = map[string]int32{
	"LINK_ADDED":   0,
	"LINK_UPDATED": 1,
	"LINK_DELETED": 2,
}

Functions

func RegisterNewsServer

func RegisterNewsServer(s *grpc.Server, srv NewsServer)

Types

type Event

type Event struct {
	EventType            EventType            `protobuf:"varint,1,opt,name=eventType,proto3,enum=pb.EventType" json:"eventType,omitempty"`
	Username             string               `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	Url                  string               `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
	Timestamp            *timestamp.Timestamp `protobuf:"bytes,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

func (*Event) Descriptor

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

func (*Event) GetEventType

func (m *Event) GetEventType() EventType

func (*Event) GetTimestamp

func (m *Event) GetTimestamp() *timestamp.Timestamp

func (*Event) GetUrl

func (m *Event) GetUrl() string

func (*Event) GetUsername

func (m *Event) GetUsername() string

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) Reset

func (m *Event) Reset()

func (*Event) String

func (m *Event) String() string

func (*Event) XXX_DiscardUnknown

func (m *Event) XXX_DiscardUnknown()

func (*Event) XXX_Marshal

func (m *Event) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Event) XXX_Merge

func (dst *Event) XXX_Merge(src proto.Message)

func (*Event) XXX_Size

func (m *Event) XXX_Size() int

func (*Event) XXX_Unmarshal

func (m *Event) XXX_Unmarshal(b []byte) error

type EventType

type EventType int32

const (
	EventType_LINK_ADDED   EventType = 0
	EventType_LINK_UPDATED EventType = 1
	EventType_LINK_DELETED EventType = 2
)

func (EventType) EnumDescriptor

func (EventType) EnumDescriptor() ([]byte, []int)

func (EventType) String

func (x EventType) String() string

type GetNewsRequest

type GetNewsRequest struct {
	Username             string   `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	StartToken           string   `protobuf:"bytes,2,opt,name=startToken,proto3" json:"startToken,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetNewsRequest) Descriptor

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

func (*GetNewsRequest) GetStartToken

func (m *GetNewsRequest) GetStartToken() string

func (*GetNewsRequest) GetUsername

func (m *GetNewsRequest) GetUsername() string

func (*GetNewsRequest) ProtoMessage

func (*GetNewsRequest) ProtoMessage()

func (*GetNewsRequest) Reset

func (m *GetNewsRequest) Reset()

func (*GetNewsRequest) String

func (m *GetNewsRequest) String() string

func (*GetNewsRequest) XXX_DiscardUnknown

func (m *GetNewsRequest) XXX_DiscardUnknown()

func (*GetNewsRequest) XXX_Marshal

func (m *GetNewsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetNewsRequest) XXX_Merge

func (dst *GetNewsRequest) XXX_Merge(src proto.Message)

func (*GetNewsRequest) XXX_Size

func (m *GetNewsRequest) XXX_Size() int

func (*GetNewsRequest) XXX_Unmarshal

func (m *GetNewsRequest) XXX_Unmarshal(b []byte) error

type GetNewsResponse

type GetNewsResponse struct {
	Events               []*Event `protobuf:"bytes,1,rep,name=events,proto3" json:"events,omitempty"`
	NextToken            string   `protobuf:"bytes,2,opt,name=nextToken,proto3" json:"nextToken,omitempty"`
	Err                  string   `protobuf:"bytes,3,opt,name=err,proto3" json:"err,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetNewsResponse) Descriptor

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

func (*GetNewsResponse) GetErr

func (m *GetNewsResponse) GetErr() string

func (*GetNewsResponse) GetEvents

func (m *GetNewsResponse) GetEvents() []*Event

func (*GetNewsResponse) GetNextToken

func (m *GetNewsResponse) GetNextToken() string

func (*GetNewsResponse) ProtoMessage

func (*GetNewsResponse) ProtoMessage()

func (*GetNewsResponse) Reset

func (m *GetNewsResponse) Reset()

func (*GetNewsResponse) String

func (m *GetNewsResponse) String() string

func (*GetNewsResponse) XXX_DiscardUnknown

func (m *GetNewsResponse) XXX_DiscardUnknown()

func (*GetNewsResponse) XXX_Marshal

func (m *GetNewsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetNewsResponse) XXX_Merge

func (dst *GetNewsResponse) XXX_Merge(src proto.Message)

func (*GetNewsResponse) XXX_Size

func (m *GetNewsResponse) XXX_Size() int

func (*GetNewsResponse) XXX_Unmarshal

func (m *GetNewsResponse) XXX_Unmarshal(b []byte) error

type NewsClient

type NewsClient interface {
	GetNews(ctx context.Context, in *GetNewsRequest, opts ...grpc.CallOption) (*GetNewsResponse, error)
}

NewsClient is the client API for News service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewNewsClient

func NewNewsClient(cc *grpc.ClientConn) NewsClient

type NewsServer

type NewsServer interface {
	GetNews(context.Context, *GetNewsRequest) (*GetNewsResponse, error)
}

NewsServer is the server API for News service.