Skip to content
Ghaf Framework

Socket Go-API

socketproxy

Section titled “socketproxy”
import "givc/modules/api/socket"

Index

Section titled “Index”

Constants

Section titled “Constants”

const (
    // Verify that this generated code is sufficiently up-to-date.
    _   = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
    // Verify that runtime/protoimpl is sufficiently up-to-date.
    _   = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)

const (
    SocketStream_TransferData_FullMethodName = "/socketproxy.SocketStream/TransferData"
)

This is a compile-time assertion to ensure that this generated file is compatible with the grpc package it is being compiled against. Requires gRPC-Go v1.64.0 or later.

const _ = grpc.SupportPackageIsVersion9

const file_socket_socket_proto_rawDesc = "" +
    "\n" +
    "\x13socket/socket.proto\x12\vsocketproxy\" \n" +
    "\n" +
    "BytePacket\x12\x12\n" +
    "\x04Data\x18\x01 \x01(\fR\x04Data2V\n" +
    "\fSocketStream\x12F\n" +
    "\fTransferData\x12\x17.socketproxy.BytePacket\x1a\x17.socketproxy.BytePacket\"\x00(\x010\x01B\x1eZ\x1cgivc/modules/api/socketproxyb\x06proto3"

Variables

Section titled “Variables”

var (
    file_socket_socket_proto_rawDescOnce sync.Once
    file_socket_socket_proto_rawDescData []byte
)

var File_socket_socket_proto protoreflect.FileDescriptor

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

var SocketStream_ServiceDesc = grpc.ServiceDesc{
    ServiceName: "socketproxy.SocketStream",
    HandlerType: (*SocketStreamServer)(nil),
    Methods:     []grpc.MethodDesc{},
    Streams: []grpc.StreamDesc{
        {
            StreamName:    "TransferData",
            Handler:       _SocketStream_TransferData_Handler,
            ServerStreams: true,
            ClientStreams: true,
        },
    },
    Metadata: "socket/socket.proto",
}

var file_socket_socket_proto_depIdxs = []int32{
    0,
    0,
    1,
    0,
    0,
    0,
    0,
}

var file_socket_socket_proto_goTypes = []any{
    (*BytePacket)(nil),
}

var file_socket_socket_proto_msgTypes = make([]protoimpl.MessageInfo, 1)

func RegisterSocketStreamServer

Section titled “func RegisterSocketStreamServer”
func RegisterSocketStreamServer(s grpc.ServiceRegistrar, srv SocketStreamServer)

func _SocketStream_TransferData_Handler

Section titled “func _SocketStream_TransferData_Handler”
func _SocketStream_TransferData_Handler(srv interface{}, stream grpc.ServerStream) error

func file_socket_socket_proto_init

Section titled “func file_socket_socket_proto_init”
func file_socket_socket_proto_init()

func file_socket_socket_proto_rawDescGZIP

Section titled “func file_socket_socket_proto_rawDescGZIP”
func file_socket_socket_proto_rawDescGZIP() []byte

func init

Section titled “func init”
func init()

type BytePacket

Section titled “type BytePacket”
type BytePacket struct {
    state         protoimpl.MessageState `protogen:"open.v1"`
    Data          []byte                 `protobuf:"bytes,1,opt,name=Data,proto3" json:"Data,omitempty"`
    unknownFields protoimpl.UnknownFields
    sizeCache     protoimpl.SizeCache
}

func (*BytePacket) Descriptor

Section titled “func (*BytePacket) Descriptor”
func (*BytePacket) Descriptor() ([]byte, []int)

Deprecated: Use BytePacket.ProtoReflect.Descriptor instead.

func (*BytePacket) GetData

Section titled “func (*BytePacket) GetData”
func (x *BytePacket) GetData() []byte

func (*BytePacket) ProtoMessage

Section titled “func (*BytePacket) ProtoMessage”
func (*BytePacket) ProtoMessage()

func (*BytePacket) ProtoReflect

Section titled “func (*BytePacket) ProtoReflect”
func (x *BytePacket) ProtoReflect() protoreflect.Message

func (*BytePacket) Reset

Section titled “func (*BytePacket) Reset”
func (x *BytePacket) Reset()

func (*BytePacket) String

Section titled “func (*BytePacket) String”
func (x *BytePacket) String() string

type SocketStreamClient

Section titled “type SocketStreamClient”

SocketStreamClient is the client API for SocketStream 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.

type SocketStreamClient interface {
    TransferData(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[BytePacket, BytePacket], error)
}

func NewSocketStreamClient

Section titled “func NewSocketStreamClient”
func NewSocketStreamClient(cc grpc.ClientConnInterface) SocketStreamClient

type SocketStreamServer

Section titled “type SocketStreamServer”

SocketStreamServer is the server API for SocketStream service. All implementations must embed UnimplementedSocketStreamServer for forward compatibility.

type SocketStreamServer interface {
    TransferData(grpc.BidiStreamingServer[BytePacket, BytePacket]) error
    mustEmbedUnimplementedSocketStreamServer()
}

type SocketStream_TransferDataClient

Section titled “type SocketStream_TransferDataClient”

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

type SocketStream_TransferDataClient = grpc.BidiStreamingClient[BytePacket, BytePacket]

type SocketStream_TransferDataServer

Section titled “type SocketStream_TransferDataServer”

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

type SocketStream_TransferDataServer = grpc.BidiStreamingServer[BytePacket, BytePacket]

type UnimplementedSocketStreamServer

Section titled “type UnimplementedSocketStreamServer”

UnimplementedSocketStreamServer 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.

type UnimplementedSocketStreamServer struct{}

func (UnimplementedSocketStreamServer) TransferData

Section titled “func (UnimplementedSocketStreamServer) TransferData”
func (UnimplementedSocketStreamServer) TransferData(grpc.BidiStreamingServer[BytePacket, BytePacket]) error

func (UnimplementedSocketStreamServer) mustEmbedUnimplementedSocketStreamServer

Section titled “func (UnimplementedSocketStreamServer) mustEmbedUnimplementedSocketStreamServer”
func (UnimplementedSocketStreamServer) mustEmbedUnimplementedSocketStreamServer()

func (UnimplementedSocketStreamServer) testEmbeddedByValue

Section titled “func (UnimplementedSocketStreamServer) testEmbeddedByValue”
func (UnimplementedSocketStreamServer) testEmbeddedByValue()

type UnsafeSocketStreamServer

Section titled “type UnsafeSocketStreamServer”

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

type UnsafeSocketStreamServer interface {
    mustEmbedUnimplementedSocketStreamServer()
}

type socketStreamClient

Section titled “type socketStreamClient”
type socketStreamClient struct {
    cc grpc.ClientConnInterface
}

func (*socketStreamClient) TransferData

Section titled “func (*socketStreamClient) TransferData”
func (c *socketStreamClient) TransferData(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[BytePacket, BytePacket], error)

Generated by gomarkdoc