internal

Documentation

Index

• Constants
• func Infer[T any](pkt GonnectPacket[any]) (*T, error)
• func WgFromContext(ctx context.Context) *sync.WaitGroup
• func WithIdentity(ctx context.Context, identity GonnectIdentity) context.Context
• func WithWg(ctx context.Context, wg *sync.WaitGroup) context.Context
• type ChanMsg
  • func NewChanMsg(msg []byte, err error) ChanMsg
• type GonnectClipboard
  • func (GonnectClipboard) Type() GonnectMessageType
• type GonnectClipboardConnect
  • func (GonnectClipboardConnect) Type() GonnectMessageType
• type GonnectIdentity
  • func Identity() GonnectIdentity
  • func IdentityFromContext(ctx context.Context) *GonnectIdentity
  • func (GonnectIdentity) Type() GonnectMessageType
• type GonnectMessageType
• type GonnectPacket
  • func NewGonnectPacket[T GonnectPacketType](body T) GonnectPacket[T]
• type GonnectPacketType
• type GonnectPair
  • func (GonnectPair) Type() GonnectMessageType
• type GonnectPing
  • func (GonnectPing) Type() GonnectMessageType

Constants

const (
	GonnectPingType             = GonnectMessageType("kdeconnect.ping")
	GonnectPairType             = GonnectMessageType("kdeconnect.pair")
	GonnectClipboardType        = GonnectMessageType("kdeconnect.clipboard")
	GonnectClipboardConnectType = GonnectMessageType("kdeconnect.clipboard.connect")
	GonnectIdentityType         = GonnectMessageType("kdeconnect.identity")
)

const (
	ProtocolVersion = 7
)

Functions

func Infer

func Infer[T any](pkt GonnectPacket[any]) (*T, error)

func WgFromContext

func WgFromContext(ctx context.Context) *sync.WaitGroup

func WithIdentity

func WithIdentity(ctx context.Context, identity GonnectIdentity) context.Context

func WithWg

func WithWg(ctx context.Context, wg *sync.WaitGroup) context.Context

Types

type ChanMsg

type ChanMsg struct {
	Msg []byte
	Err error
}

A struct used for passing data between goroutines

func NewChanMsg

func NewChanMsg(msg []byte, err error) ChanMsg

Create a new ChanMsg and copy the underlying slice since it is not thread safe

type GonnectClipboard

type GonnectClipboard struct {
	Content string `json:"content"`
}

func (GonnectClipboard) Type

func (GonnectClipboard) Type() GonnectMessageType

type GonnectClipboardConnect

type GonnectClipboardConnect struct {
	GonnectClipboard
	Timestamp int `json:"timestamp"`
}

func (GonnectClipboardConnect) Type

func (GonnectClipboardConnect) Type() GonnectMessageType

type GonnectIdentity

type GonnectIdentity struct {
	DeviceId             string   `json:"deviceId"`
	DeviceName           string   `json:"deviceName"`
	DeviceType           string   `json:"deviceType"`
	IncomingCapabilities []string `json:"incomingCapabilities"`
	OutgoingCapabilities []string `json:"outgoingCapabilities"`
	ProtocolVersion      int      `json:"protocolVersion"`
	TcpPort              uint16   `json:"tcpPort"`
}

func Identity

func Identity() GonnectIdentity

func IdentityFromContext

func IdentityFromContext(ctx context.Context) *GonnectIdentity

func (GonnectIdentity) Type

func (GonnectIdentity) Type() GonnectMessageType

type GonnectMessageType

type GonnectMessageType string

type GonnectPacket

type GonnectPacket[T any] struct {
	Id   int64              `json:"id"`
	Type GonnectMessageType `json:"type"`
	Body T                  `json:"body"`
}

func NewGonnectPacket

func NewGonnectPacket[T GonnectPacketType](body T) GonnectPacket[T]

type GonnectPacketType

type GonnectPacketType interface {
	Type() GonnectMessageType
}

type GonnectPair

type GonnectPair struct {
	Pair bool `json:"pair"`
}

func (GonnectPair) Type

func (GonnectPair) Type() GonnectMessageType

type GonnectPing

type GonnectPing struct {
	Message *string `json:"message"`
}

func (GonnectPing) Type

func (GonnectPing) Type() GonnectMessageType