Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterDiscoverAPIServer(s grpc.ServiceRegistrar, srv DiscoverAPIServer)
- type DiscoverAPIClient
- type DiscoverAPIServer
- type DiscoverAPI_WatchApplicationsClient
- type DiscoverAPI_WatchApplicationsServer
- type Identity
- type UnimplementedDiscoverAPIServer
- type UnsafeDiscoverAPIServer
- type WatchApplicationsRequest
- type WatchApplicationsResponse
- func (*WatchApplicationsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *WatchApplicationsResponse) GetAvailable() bool
- func (x *WatchApplicationsResponse) GetIdentity() *Identity
- func (x *WatchApplicationsResponse) GetSite() *Identity
- func (*WatchApplicationsResponse) ProtoMessage()
- func (x *WatchApplicationsResponse) ProtoReflect() protoreflect.Message
- func (x *WatchApplicationsResponse) Reset()
- func (x *WatchApplicationsResponse) String() string
Constants ¶
const (
DiscoverAPI_WatchApplications_FullMethodName = "/dogma.interop.v1.discover.DiscoverAPI/WatchApplications"
)
Variables ¶
var DiscoverAPI_ServiceDesc = grpc.ServiceDesc{ ServiceName: "dogma.interop.v1.discover.DiscoverAPI", HandlerType: (*DiscoverAPIServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "WatchApplications", Handler: _DiscoverAPI_WatchApplications_Handler, ServerStreams: true, }, }, Metadata: "github.com/dogmatiq/interopspec/discoverspec/discoverapi.proto", }
DiscoverAPI_ServiceDesc is the grpc.ServiceDesc for DiscoverAPI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_github_com_dogmatiq_interopspec_discoverspec_discoverapi_proto protoreflect.FileDescriptor
Functions ¶
func RegisterDiscoverAPIServer ¶ added in v0.2.1
func RegisterDiscoverAPIServer(s grpc.ServiceRegistrar, srv DiscoverAPIServer)
Types ¶
type DiscoverAPIClient ¶ added in v0.2.1
type DiscoverAPIClient interface { // WatchApplications starts watching the server for updates to the // availability of Dogma applications. // // When the call is first made the client sends a response for each // application that is currently available on the server. After this time the // server sends a response each time the availability of a specific // application changes. WatchApplications(ctx context.Context, in *WatchApplicationsRequest, opts ...grpc.CallOption) (DiscoverAPI_WatchApplicationsClient, error) }
DiscoverAPIClient is the client API for DiscoverAPI service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewDiscoverAPIClient ¶ added in v0.2.1
func NewDiscoverAPIClient(cc grpc.ClientConnInterface) DiscoverAPIClient
type DiscoverAPIServer ¶ added in v0.2.1
type DiscoverAPIServer interface { // WatchApplications starts watching the server for updates to the // availability of Dogma applications. // // When the call is first made the client sends a response for each // application that is currently available on the server. After this time the // server sends a response each time the availability of a specific // application changes. WatchApplications(*WatchApplicationsRequest, DiscoverAPI_WatchApplicationsServer) error }
DiscoverAPIServer is the server API for DiscoverAPI service. All implementations should embed UnimplementedDiscoverAPIServer for forward compatibility
type DiscoverAPI_WatchApplicationsClient ¶ added in v0.5.0
type DiscoverAPI_WatchApplicationsClient interface { Recv() (*WatchApplicationsResponse, error) grpc.ClientStream }
type DiscoverAPI_WatchApplicationsServer ¶ added in v0.5.0
type DiscoverAPI_WatchApplicationsServer interface { Send(*WatchApplicationsResponse) error grpc.ServerStream }
type Identity ¶ added in v0.2.1
type Identity struct { // Name is the application's unique name. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Key is the application's immutable, unique key. Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"` // contains filtered or unexported fields }
Identity represents the identity of an application.
func (*Identity) Descriptor
deprecated
added in
v0.2.1
func (*Identity) ProtoMessage ¶ added in v0.2.1
func (*Identity) ProtoMessage()
func (*Identity) ProtoReflect ¶ added in v0.2.1
func (x *Identity) ProtoReflect() protoreflect.Message
type UnimplementedDiscoverAPIServer ¶ added in v0.2.1
type UnimplementedDiscoverAPIServer struct { }
UnimplementedDiscoverAPIServer should be embedded to have forward compatible implementations.
func (UnimplementedDiscoverAPIServer) WatchApplications ¶ added in v0.5.0
func (UnimplementedDiscoverAPIServer) WatchApplications(*WatchApplicationsRequest, DiscoverAPI_WatchApplicationsServer) error
type UnsafeDiscoverAPIServer ¶ added in v0.5.1
type UnsafeDiscoverAPIServer interface {
// contains filtered or unexported methods
}
UnsafeDiscoverAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DiscoverAPIServer will result in compilation errors.
type WatchApplicationsRequest ¶ added in v0.5.0
type WatchApplicationsRequest struct {
// contains filtered or unexported fields
}
func (*WatchApplicationsRequest) Descriptor
deprecated
added in
v0.5.0
func (*WatchApplicationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use WatchApplicationsRequest.ProtoReflect.Descriptor instead.
func (*WatchApplicationsRequest) ProtoMessage ¶ added in v0.5.0
func (*WatchApplicationsRequest) ProtoMessage()
func (*WatchApplicationsRequest) ProtoReflect ¶ added in v0.5.0
func (x *WatchApplicationsRequest) ProtoReflect() protoreflect.Message
func (*WatchApplicationsRequest) Reset ¶ added in v0.5.0
func (x *WatchApplicationsRequest) Reset()
func (*WatchApplicationsRequest) String ¶ added in v0.5.0
func (x *WatchApplicationsRequest) String() string
type WatchApplicationsResponse ¶ added in v0.5.0
type WatchApplicationsResponse struct { // Identity is the identity key of the Dogma application that the response is // about. Identity *Identity `protobuf:"bytes,1,opt,name=identity,proto3" json:"identity,omitempty"` // SourceSite is the (optional) identity of the site that the application is // running within. // // The site is used to disambiguate between messages from different // installations of the same application. Site *Identity `protobuf:"bytes,3,opt,name=site,proto3" json:"site,omitempty"` // Available indicates whether the application should currently be considered // available or not. Available bool `protobuf:"varint,2,opt,name=available,proto3" json:"available,omitempty"` // contains filtered or unexported fields }
func (*WatchApplicationsResponse) Descriptor
deprecated
added in
v0.5.0
func (*WatchApplicationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use WatchApplicationsResponse.ProtoReflect.Descriptor instead.
func (*WatchApplicationsResponse) GetAvailable ¶ added in v0.5.0
func (x *WatchApplicationsResponse) GetAvailable() bool
func (*WatchApplicationsResponse) GetIdentity ¶ added in v0.5.0
func (x *WatchApplicationsResponse) GetIdentity() *Identity
func (*WatchApplicationsResponse) GetSite ¶ added in v0.5.2
func (x *WatchApplicationsResponse) GetSite() *Identity
func (*WatchApplicationsResponse) ProtoMessage ¶ added in v0.5.0
func (*WatchApplicationsResponse) ProtoMessage()
func (*WatchApplicationsResponse) ProtoReflect ¶ added in v0.5.0
func (x *WatchApplicationsResponse) ProtoReflect() protoreflect.Message
func (*WatchApplicationsResponse) Reset ¶ added in v0.5.0
func (x *WatchApplicationsResponse) Reset()
func (*WatchApplicationsResponse) String ¶ added in v0.5.0
func (x *WatchApplicationsResponse) String() string