socketapi

Documentation

Index

• Constants
• type SocketCommandID
• type SocketCommandUserDisable
• type SocketCommandUserDisableReply
• type SocketCommandUserEnable
• type SocketCommandUserEnableReply

Constants

const (
	SocketFilename = ".socket" // socket filename

	SCVersion     = 1             // socket API version
	SCUserEnable  = "userenable"  // ID for SocketCommandUserEnable
	SCUserDisable = "userdisable" // ID for SocketCommandUserDisable
)

Types

type SocketCommandID

type SocketCommandID struct {
	Version uint   `json:"version"`
	Command string `json:"command"`
}

SocketCommandID identifies the command that follows.

type SocketCommandUserDisable

type SocketCommandUserDisable struct {
	Identity string `json:"identity"` // public identity
}

SocketCommandUserDisable attempts to disable a user. We require a user identity here in order to ensure uniqueness.

type SocketCommandUserDisableReply

type SocketCommandUserDisableReply struct {
	Error string `json:"error"`
}

SocketCommandUserDisableReply returns "" if the command was successful.

type SocketCommandUserEnable

type SocketCommandUserEnable struct {
	Identity string `json:"identity"` // public identity
}

SocketCommandUserEnable attempts to enable a user. We require a user identity here in order to ensure uniqueness.

type SocketCommandUserEnableReply

type SocketCommandUserEnableReply struct {
	Error string `json:"error"`
}

SocketCommandUserEnableReply returns "" if the command was successful.