scpacket

Documentation

Index

• Constants
• Variables
• type CmdInputTextPacketType
  • func MakeCmdInputTextPacket(screenId string) *CmdInputTextPacketType
  • func (*CmdInputTextPacketType) GetType() string
• type EphemeralCommandResponsePacketType
  • func (*EphemeralCommandResponsePacketType) GetType() string
• type FeActivityPacketType
  • func MakeFeActivityPacket() *FeActivityPacketType
  • func (*FeActivityPacketType) GetType() string
• type FeCommandPacketType
  • func MakeFeCommandPacket() *FeCommandPacketType
  • func (pk *FeCommandPacketType) GetRawStr() string
  • func (*FeCommandPacketType) GetType() string
• type FeInputPacketType
  • func MakeFeInputPacket() *FeInputPacketType
  • func (pk *FeInputPacketType) DecodeData() ([]byte, error)
  • func (*FeInputPacketType) GetType() string
  • func (pk *FeInputPacketType) SetData(data []byte)
• type PacketType
• type RemoteInputPacketType
  • func MakeRemoteInputPacket() *RemoteInputPacketType
  • func (*RemoteInputPacketType) GetType() string
• type RemotePtrType
  • func (rptr *RemotePtrType) GetDisplayName(baseDisplayName string) string
  • func (r RemotePtrType) IsSessionScope() bool
  • func (r RemotePtrType) MakeFullRemoteRef() string
  • func (r RemotePtrType) Validate() error
• type UIContextType
• type WatchScreenPacketType
  • func MakeWatchScreenPacket() *WatchScreenPacketType
  • func (*WatchScreenPacketType) GetType() string

Constants

const (
	FeCommandPacketStr                = "fecmd"
	WatchScreenPacketStr              = "watchscreen"
	FeInputPacketStr                  = "feinput"
	RemoteInputPacketStr              = "remoteinput"
	CmdInputTextPacketStr             = "cmdinputtext"
	EphemeralCommandResponsePacketStr = "ephemeralcommandresponse"
	FeActivityPacketStr               = "feactivity"
)

Variables

var RemoteNameRe = regexp.MustCompile(`^\*?[a-zA-Z0-9_-]+$`)

Types

type CmdInputTextPacketType

type CmdInputTextPacketType struct {
	Type     string            `json:"type"`
	SeqNum   int               `json:"seqnum"`
	ScreenId string            `json:"screenid"`
	Text     utilfn.StrWithPos `json:"text"`
}

func MakeCmdInputTextPacket

func MakeCmdInputTextPacket(screenId string) *CmdInputTextPacketType

func (*CmdInputTextPacketType) GetType

func (*CmdInputTextPacketType) GetType() string

type EphemeralCommandResponsePacketType

type EphemeralCommandResponsePacketType struct {
	Type      string `json:"type"`
	StdoutUrl string `json:"stdouturl"`
	StderrUrl string `json:"stderrurl"`
	Error     string `json:"error,omitempty"`
}

func (*EphemeralCommandResponsePacketType) GetType

func (*EphemeralCommandResponsePacketType) GetType() string

type FeActivityPacketType

type FeActivityPacketType struct {
	Type     string         `json:"type"`
	Activity map[string]int `json:"activity"`
}

func MakeFeActivityPacket

func MakeFeActivityPacket() *FeActivityPacketType

func (*FeActivityPacketType) GetType

func (*FeActivityPacketType) GetType() string

type FeCommandPacketType

type FeCommandPacketType struct {
	Type          string                      `json:"type"`
	MetaCmd       string                      `json:"metacmd"`
	MetaSubCmd    string                      `json:"metasubcmd,omitempty"`
	Args          []string                    `json:"args,omitempty"`
	Kwargs        map[string]string           `json:"kwargs,omitempty"`
	RawStr        string                      `json:"rawstr,omitempty"`
	UIContext     *UIContextType              `json:"uicontext,omitempty"`
	Interactive   bool                        `json:"interactive"`
	EphemeralOpts *ephemeral.EphemeralRunOpts `json:"ephemeralopts,omitempty"`
}

func MakeFeCommandPacket

func MakeFeCommandPacket() *FeCommandPacketType

func (*FeCommandPacketType) GetRawStr

func (pk *FeCommandPacketType) GetRawStr() string

func (*FeCommandPacketType) GetType

func (*FeCommandPacketType) GetType() string

type FeInputPacketType

type FeInputPacketType struct {
	Type        string          `json:"type"`
	CK          base.CommandKey `json:"ck"`
	Remote      RemotePtrType   `json:"remote"`
	InputData64 string          `json:"inputdata64"`
	SigName     string          `json:"signame,omitempty"`
	WinSize     *packet.WinSize `json:"winsize,omitempty"`
}

func MakeFeInputPacket

func MakeFeInputPacket() *FeInputPacketType

func (*FeInputPacketType) DecodeData

func (pk *FeInputPacketType) DecodeData() ([]byte, error)

func (*FeInputPacketType) GetType

func (*FeInputPacketType) GetType() string

func (*FeInputPacketType) SetData

func (pk *FeInputPacketType) SetData(data []byte)

type PacketType

type PacketType interface {
	GetType() string
}

type RemoteInputPacketType

type RemoteInputPacketType struct {
	Type        string `json:"type"`
	RemoteId    string `json:"remoteid"`
	InputData64 string `json:"inputdata64"`
}

func MakeRemoteInputPacket

func MakeRemoteInputPacket() *RemoteInputPacketType

func (*RemoteInputPacketType) GetType

func (*RemoteInputPacketType) GetType() string

type RemotePtrType

type RemotePtrType struct {
	OwnerId  string `json:"ownerid"`
	RemoteId string `json:"remoteid"`
	Name     string `json:"name"`
}

func (*RemotePtrType) GetDisplayName

func (rptr *RemotePtrType) GetDisplayName(baseDisplayName string) string

func (RemotePtrType) IsSessionScope

func (r RemotePtrType) IsSessionScope() bool

func (RemotePtrType) MakeFullRemoteRef

func (r RemotePtrType) MakeFullRemoteRef() string

func (RemotePtrType) Validate

func (r RemotePtrType) Validate() error

type UIContextType

type UIContextType struct {
	SessionId string          `json:"sessionid"`
	ScreenId  string          `json:"screenid"`
	Remote    *RemotePtrType  `json:"remote,omitempty"`
	WinSize   *packet.WinSize `json:"winsize,omitempty"`
	Build     string          `json:"build,omitempty"`
}

type WatchScreenPacketType

type WatchScreenPacketType struct {
	Type      string `json:"type"`
	SessionId string `json:"sessionid"`
	ScreenId  string `json:"screenid"`
	Connect   bool   `json:"connect"`
	AuthKey   string `json:"authkey"`
}

func MakeWatchScreenPacket

func MakeWatchScreenPacket() *WatchScreenPacketType

func (*WatchScreenPacketType) GetType

func (*WatchScreenPacketType) GetType() string