Enum TcpClientMessage 

pub enum TcpClientMessage {
    Login {
        password: String,
        user_name: String,
        user_role: UserRole,
    },
    Logout,
    Relogin {
        user_id: SessionID,
        clear_subscriptions: bool,
    },
    Subscribe {
        topic: SubscribeTopic,
        update_mode: UpdateMode,
    },
    Unsubscribe {
        topic: SubscribeTopic,
    },
    ExecuteCommand {
        command: String,
        response_id: u32,
    },
    ExecuteImplicitCommand {
        command: CliAction,
        response_id: u32,
    },
    RequestEdit(EditableResource),
    SubmitEdit {
        resource: EditableResource,
        new_data: Vec<u8>,
    },
    DropEditLock(EditableResource),
}

Represents all valid messages dispatched from a client to the kernel over an active TCP connection.

Variants

Login

Request to authenticate a new session.

Fields

password: String

user_name: String

user_role: UserRole

Logout

Request to safely terminate the current session.

Relogin

Request to resume a previous session using an existing token.

Fields

user_id: SessionID

clear_subscriptions: bool

Subscribe

Request to listen for state changes on a specific topic.

Fields

topic: SubscribeTopic

update_mode: UpdateMode

Unsubscribe

Request to stop receiving updates for a specific topic.

Fields

topic: SubscribeTopic

ExecuteCommand

Submits a raw CLI string for the server to parse and execute.

Fields

command: String

response_id: u32

ExecuteImplicitCommand

Submits a pre-parsed, structured CLI action directly.

Fields

command: CliAction

response_id: u32

RequestEdit(EditableResource)

Requests exclusive editing rights for a specific engine resource.

SubmitEdit

Submits modifications for an exclusively locked resource.

Fields

resource: EditableResource

new_data: Vec<u8>

DropEditLock(EditableResource)

Drops the Lock on an exclusively locked resource, giving other Clients the chance to lock it.

Trait Implementations

impl Debug for TcpClientMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TcpClientMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TcpClientMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.