api

package
v0.0.0-...-ce562c0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 25, 2025 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	FireflyService_RegisterNode_FullMethodName    = "/api.FireflyService/RegisterNode"
	FireflyService_Heartbeat_FullMethodName       = "/api.FireflyService/Heartbeat"
	FireflyService_SyncLibrary_FullMethodName     = "/api.FireflyService/SyncLibrary"
	FireflyService_RequestPlayback_FullMethodName = "/api.FireflyService/RequestPlayback"
	FireflyService_SyncPlayback_FullMethodName    = "/api.FireflyService/SyncPlayback"
)

Variables

View Source 
var File_api_firefly_proto protoreflect.FileDescriptor
View Source 
var FireflyService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.FireflyService",
	HandlerType: (*FireflyServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "RegisterNode",
			Handler:    _FireflyService_RegisterNode_Handler,
		},
		{
			MethodName: "Heartbeat",
			Handler:    _FireflyService_Heartbeat_Handler,
		},
		{
			MethodName: "SyncLibrary",
			Handler:    _FireflyService_SyncLibrary_Handler,
		},
		{
			MethodName: "RequestPlayback",
			Handler:    _FireflyService_RequestPlayback_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "SyncPlayback",
			Handler:       _FireflyService_SyncPlayback_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "api/firefly.proto",
}

FireflyService_ServiceDesc is the grpc.ServiceDesc for FireflyService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterFireflyServiceServer 

func RegisterFireflyServiceServer(s grpc.ServiceRegistrar, srv FireflyServiceServer)

Types

type ChunkMetadata 

type ChunkMetadata struct {

	// string chunk_id = 1;
	// int64 size_bytes = 2;
	// string checksum = 3;
	Fingerprint string `protobuf:"bytes,1,opt,name=fingerprint,proto3" json:"fingerprint,omitempty"`
	Size        int64  `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

func (*ChunkMetadata) Descriptor deprecated 

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

Deprecated: Use ChunkMetadata.ProtoReflect.Descriptor instead.

func (*ChunkMetadata) GetFingerprint 

func (x *ChunkMetadata) GetFingerprint() string

func (*ChunkMetadata) GetSize 

func (x *ChunkMetadata) GetSize() int64

func (*ChunkMetadata) ProtoMessage 

func (*ChunkMetadata) ProtoMessage()

func (*ChunkMetadata) ProtoReflect 

func (x *ChunkMetadata) ProtoReflect() protoreflect.Message

func (*ChunkMetadata) Reset 

func (x *ChunkMetadata) Reset()

func (*ChunkMetadata) String 

func (x *ChunkMetadata) String() string

type FileMetadata 

type FileMetadata struct {
	Filename string           `protobuf:"bytes,1,opt,name=filename,proto3" json:"filename,omitempty"`
	Checksum string           `protobuf:"bytes,2,opt,name=checksum,proto3" json:"checksum,omitempty"`
	Chunks   []*ChunkMetadata `protobuf:"bytes,3,rep,name=chunks,proto3" json:"chunks,omitempty"`
	// contains filtered or unexported fields
}

func (*FileMetadata) Descriptor deprecated 

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

Deprecated: Use FileMetadata.ProtoReflect.Descriptor instead.

func (*FileMetadata) GetChecksum 

func (x *FileMetadata) GetChecksum() string

func (*FileMetadata) GetChunks 

func (x *FileMetadata) GetChunks() []*ChunkMetadata

func (*FileMetadata) GetFilename 

func (x *FileMetadata) GetFilename() string

func (*FileMetadata) ProtoMessage 

func (*FileMetadata) ProtoMessage()

func (*FileMetadata) ProtoReflect 

func (x *FileMetadata) ProtoReflect() protoreflect.Message

func (*FileMetadata) Reset 

func (x *FileMetadata) Reset()

func (*FileMetadata) String 

func (x *FileMetadata) String() string

type FireflyServiceClient 

type FireflyServiceClient interface {
	RegisterNode(ctx context.Context, in *RegisterRequest, opts ...grpc.CallOption) (*RegisterResponse, error)
	Heartbeat(ctx context.Context, in *HeartbeatRequest, opts ...grpc.CallOption) (*HeartbeatResponse, error)
	SyncLibrary(ctx context.Context, in *SyncLibraryRequest, opts ...grpc.CallOption) (*SyncLibraryResponse, error)
	RequestPlayback(ctx context.Context, in *PlaybackRequest, opts ...grpc.CallOption) (*PlaybackResponse, error)
	SyncPlayback(ctx context.Context, in *SyncPlaybackCommand, opts ...grpc.CallOption) (grpc.ServerStreamingClient[SyncPlaybackResponse], error)
}

FireflyServiceClient is the client API for FireflyService 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 NewFireflyServiceClient 

func NewFireflyServiceClient(cc grpc.ClientConnInterface) FireflyServiceClient

type FireflyServiceServer 

type FireflyServiceServer interface {
	RegisterNode(context.Context, *RegisterRequest) (*RegisterResponse, error)
	Heartbeat(context.Context, *HeartbeatRequest) (*HeartbeatResponse, error)
	SyncLibrary(context.Context, *SyncLibraryRequest) (*SyncLibraryResponse, error)
	RequestPlayback(context.Context, *PlaybackRequest) (*PlaybackResponse, error)
	SyncPlayback(*SyncPlaybackCommand, grpc.ServerStreamingServer[SyncPlaybackResponse]) error
	// contains filtered or unexported methods
}

FireflyServiceServer is the server API for FireflyService service. All implementations must embed UnimplementedFireflyServiceServer for forward compatibility.

type FireflyService_SyncPlaybackClient 

type FireflyService_SyncPlaybackClient = grpc.ServerStreamingClient[SyncPlaybackResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type FireflyService_SyncPlaybackServer 

type FireflyService_SyncPlaybackServer = grpc.ServerStreamingServer[SyncPlaybackResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type HeartbeatRequest 

type HeartbeatRequest struct {
	NodeId string `protobuf:"bytes,1,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
	// contains filtered or unexported fields
}

func (*HeartbeatRequest) Descriptor deprecated 

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

Deprecated: Use HeartbeatRequest.ProtoReflect.Descriptor instead.

func (*HeartbeatRequest) GetNodeId 

func (x *HeartbeatRequest) GetNodeId() string

func (*HeartbeatRequest) ProtoMessage 

func (*HeartbeatRequest) ProtoMessage()

func (*HeartbeatRequest) ProtoReflect 

func (x *HeartbeatRequest) ProtoReflect() protoreflect.Message

func (*HeartbeatRequest) Reset 

func (x *HeartbeatRequest) Reset()

func (*HeartbeatRequest) String 

func (x *HeartbeatRequest) String() string

type HeartbeatResponse 

type HeartbeatResponse struct {
	Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	// contains filtered or unexported fields
}

func (*HeartbeatResponse) Descriptor deprecated 

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

Deprecated: Use HeartbeatResponse.ProtoReflect.Descriptor instead.

func (*HeartbeatResponse) GetSuccess 

func (x *HeartbeatResponse) GetSuccess() bool

func (*HeartbeatResponse) ProtoMessage 

func (*HeartbeatResponse) ProtoMessage()

func (*HeartbeatResponse) ProtoReflect 

func (x *HeartbeatResponse) ProtoReflect() protoreflect.Message

func (*HeartbeatResponse) Reset 

func (x *HeartbeatResponse) Reset()

func (*HeartbeatResponse) String 

func (x *HeartbeatResponse) String() string

type PlaybackRequest 

type PlaybackRequest struct {
	NodeId   string `protobuf:"bytes,1,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
	Filename string `protobuf:"bytes,2,opt,name=filename,proto3" json:"filename,omitempty"`
	// contains filtered or unexported fields
}

func (*PlaybackRequest) Descriptor deprecated 

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

Deprecated: Use PlaybackRequest.ProtoReflect.Descriptor instead.

func (*PlaybackRequest) GetFilename 

func (x *PlaybackRequest) GetFilename() string

func (*PlaybackRequest) GetNodeId 

func (x *PlaybackRequest) GetNodeId() string

func (*PlaybackRequest) ProtoMessage 

func (*PlaybackRequest) ProtoMessage()

func (*PlaybackRequest) ProtoReflect 

func (x *PlaybackRequest) ProtoReflect() protoreflect.Message

func (*PlaybackRequest) Reset 

func (x *PlaybackRequest) Reset()

func (*PlaybackRequest) String 

func (x *PlaybackRequest) String() string

type PlaybackResponse 

type PlaybackResponse struct {
	Accepted bool `protobuf:"varint,1,opt,name=accepted,proto3" json:"accepted,omitempty"`
	// contains filtered or unexported fields
}

func (*PlaybackResponse) Descriptor deprecated 

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

Deprecated: Use PlaybackResponse.ProtoReflect.Descriptor instead.

func (*PlaybackResponse) GetAccepted 

func (x *PlaybackResponse) GetAccepted() bool

func (*PlaybackResponse) ProtoMessage 

func (*PlaybackResponse) ProtoMessage()

func (*PlaybackResponse) ProtoReflect 

func (x *PlaybackResponse) ProtoReflect() protoreflect.Message

func (*PlaybackResponse) Reset 

func (x *PlaybackResponse) Reset()

func (*PlaybackResponse) String 

func (x *PlaybackResponse) String() string

type RegisterRequest 

type RegisterRequest struct {
	NodeId   string `protobuf:"bytes,1,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
	NodeType string `protobuf:"bytes,2,opt,name=node_type,json=nodeType,proto3" json:"node_type,omitempty"`
	// contains filtered or unexported fields
}

func (*RegisterRequest) Descriptor deprecated 

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

Deprecated: Use RegisterRequest.ProtoReflect.Descriptor instead.

func (*RegisterRequest) GetNodeId 

func (x *RegisterRequest) GetNodeId() string

func (*RegisterRequest) GetNodeType 

func (x *RegisterRequest) GetNodeType() string

func (*RegisterRequest) ProtoMessage 

func (*RegisterRequest) ProtoMessage()

func (*RegisterRequest) ProtoReflect 

func (x *RegisterRequest) ProtoReflect() protoreflect.Message

func (*RegisterRequest) Reset 

func (x *RegisterRequest) Reset()

func (*RegisterRequest) String 

func (x *RegisterRequest) String() string

type RegisterResponse 

type RegisterResponse struct {
	AssignedId string `protobuf:"bytes,1,opt,name=assigned_id,json=assignedId,proto3" json:"assigned_id,omitempty"`
	MasterUrl  string `protobuf:"bytes,2,opt,name=master_url,json=masterUrl,proto3" json:"master_url,omitempty"` // revise this
	// contains filtered or unexported fields
}

func (*RegisterResponse) Descriptor deprecated 

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

Deprecated: Use RegisterResponse.ProtoReflect.Descriptor instead.

func (*RegisterResponse) GetAssignedId 

func (x *RegisterResponse) GetAssignedId() string

func (*RegisterResponse) GetMasterUrl 

func (x *RegisterResponse) GetMasterUrl() string

func (*RegisterResponse) ProtoMessage 

func (*RegisterResponse) ProtoMessage()

func (*RegisterResponse) ProtoReflect 

func (x *RegisterResponse) ProtoReflect() protoreflect.Message

func (*RegisterResponse) Reset 

func (x *RegisterResponse) Reset()

func (*RegisterResponse) String 

func (x *RegisterResponse) String() string

type SyncLibraryRequest 

type SyncLibraryRequest struct {
	NodeId string          `protobuf:"bytes,1,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
	Files  []*FileMetadata `protobuf:"bytes,2,rep,name=files,proto3" json:"files,omitempty"`
	// contains filtered or unexported fields
}

nodes inform bout their files

func (*SyncLibraryRequest) Descriptor deprecated 

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

Deprecated: Use SyncLibraryRequest.ProtoReflect.Descriptor instead.

func (*SyncLibraryRequest) GetFiles 

func (x *SyncLibraryRequest) GetFiles() []*FileMetadata

func (*SyncLibraryRequest) GetNodeId 

func (x *SyncLibraryRequest) GetNodeId() string

func (*SyncLibraryRequest) ProtoMessage 

func (*SyncLibraryRequest) ProtoMessage()

func (*SyncLibraryRequest) ProtoReflect 

func (x *SyncLibraryRequest) ProtoReflect() protoreflect.Message

func (*SyncLibraryRequest) Reset 

func (x *SyncLibraryRequest) Reset()

func (*SyncLibraryRequest) String 

func (x *SyncLibraryRequest) String() string

type SyncLibraryResponse 

type SyncLibraryResponse struct {
	MissingFiles []*FileMetadata `protobuf:"bytes,1,rep,name=missing_files,json=missingFiles,proto3" json:"missing_files,omitempty"`
	// contains filtered or unexported fields
}

func (*SyncLibraryResponse) Descriptor deprecated 

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

Deprecated: Use SyncLibraryResponse.ProtoReflect.Descriptor instead.

func (*SyncLibraryResponse) GetMissingFiles 

func (x *SyncLibraryResponse) GetMissingFiles() []*FileMetadata

func (*SyncLibraryResponse) ProtoMessage 

func (*SyncLibraryResponse) ProtoMessage()

func (*SyncLibraryResponse) ProtoReflect 

func (x *SyncLibraryResponse) ProtoReflect() protoreflect.Message

func (*SyncLibraryResponse) Reset 

func (x *SyncLibraryResponse) Reset()

func (*SyncLibraryResponse) String 

func (x *SyncLibraryResponse) String() string

type SyncPlaybackCommand 

type SyncPlaybackCommand struct {
	NodeId    string `protobuf:"bytes,1,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
	StartTime int64  `protobuf:"varint,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// contains filtered or unexported fields
}

func (*SyncPlaybackCommand) Descriptor deprecated 

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

Deprecated: Use SyncPlaybackCommand.ProtoReflect.Descriptor instead.

func (*SyncPlaybackCommand) GetNodeId 

func (x *SyncPlaybackCommand) GetNodeId() string

func (*SyncPlaybackCommand) GetStartTime 

func (x *SyncPlaybackCommand) GetStartTime() int64

func (*SyncPlaybackCommand) ProtoMessage 

func (*SyncPlaybackCommand) ProtoMessage()

func (*SyncPlaybackCommand) ProtoReflect 

func (x *SyncPlaybackCommand) ProtoReflect() protoreflect.Message

func (*SyncPlaybackCommand) Reset 

func (x *SyncPlaybackCommand) Reset()

func (*SyncPlaybackCommand) String 

func (x *SyncPlaybackCommand) String() string

type SyncPlaybackResponse 

type SyncPlaybackResponse struct {
	Filename string `protobuf:"bytes,1,opt,name=filename,proto3" json:"filename,omitempty"`
	Status   string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*SyncPlaybackResponse) Descriptor deprecated 

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

Deprecated: Use SyncPlaybackResponse.ProtoReflect.Descriptor instead.

func (*SyncPlaybackResponse) GetFilename 

func (x *SyncPlaybackResponse) GetFilename() string

func (*SyncPlaybackResponse) GetStatus 

func (x *SyncPlaybackResponse) GetStatus() string

func (*SyncPlaybackResponse) ProtoMessage 

func (*SyncPlaybackResponse) ProtoMessage()

func (*SyncPlaybackResponse) ProtoReflect 

func (x *SyncPlaybackResponse) ProtoReflect() protoreflect.Message

func (*SyncPlaybackResponse) Reset 

func (x *SyncPlaybackResponse) Reset()

func (*SyncPlaybackResponse) String 

func (x *SyncPlaybackResponse) String() string

type UnimplementedFireflyServiceServer 

type UnimplementedFireflyServiceServer struct{}

UnimplementedFireflyServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedFireflyServiceServer) Heartbeat 

func (UnimplementedFireflyServiceServer) Heartbeat(context.Context, *HeartbeatRequest) (*HeartbeatResponse, error)

func (UnimplementedFireflyServiceServer) RegisterNode 

func (UnimplementedFireflyServiceServer) RegisterNode(context.Context, *RegisterRequest) (*RegisterResponse, error)

func (UnimplementedFireflyServiceServer) RequestPlayback 

func (UnimplementedFireflyServiceServer) RequestPlayback(context.Context, *PlaybackRequest) (*PlaybackResponse, error)

func (UnimplementedFireflyServiceServer) SyncLibrary 

func (UnimplementedFireflyServiceServer) SyncLibrary(context.Context, *SyncLibraryRequest) (*SyncLibraryResponse, error)

func (UnimplementedFireflyServiceServer) SyncPlayback 

func (UnimplementedFireflyServiceServer) SyncPlayback(*SyncPlaybackCommand, grpc.ServerStreamingServer[SyncPlaybackResponse]) error

type UnsafeFireflyServiceServer 

type UnsafeFireflyServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeFireflyServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to FireflyServiceServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.