Skip to main content

plugins.ipc

local ipc = require "plugins.ipc"

__index​

(field) __index: core.object

coroutine_key​

(field) coroutine_key: unknown

file​

(field) file: string

id​

(field) id: string

last_output​

(field) last_output: string

listeners​

(field) listeners: table<string, table<integer, fun(message: plugins.ipc.message, reply: plugins.ipc.reply)|nil>>

messages​

(field) messages: plugins.ipc.message[]

method_definitions​

(field) method_definitions: table<integer, string>

methods​

(field) methods: table<string, integer>

next_update​

(field) next_update: integer

position​

(field) position: integer

primary​

(field) primary: boolean

replies​

(field) replies: plugins.ipc.reply[]

running​

(field) running: boolean

shmem​

(field) shmem: shmem?

signal_definitions​

(field) signal_definitions: table<integer, string>

signals​

(field) signals: table<string, integer>

super​

(field) super: core.object

user_dir​

(field) user_dir: string

config.plugins.ipc​

Configuration options for ipc plugin.

dirs_instance​

(field) dirs_instance: "add"|"change"|"new"

Control how to open directories in single instance mode.

single_instance​

(field) single_instance: boolean

Run a single instance of pragtical.

plugins.ipc.instance​

id​

(field) id: string

Process id of the instance.

last_update​

(field) last_update: integer

Indicates the last time this instance updated its session file.

messages​

(field) messages: plugins.ipc.message[]

The messages been broadcasted.

position​

(field) position: integer

The position in which the instance was launched.

primary​

(field) primary: boolean

Flag that indicates if this instance was the first started.

properties​

(field) properties: table

Table of properties associated with the instance. (NOT IMPLEMENTED)

replies​

(field) replies: plugins.ipc.reply[]

The replies been broadcasted.

plugins.ipc.message​

data​

(field) data: table<string, any>

A list of named values sent to receivers.

destinations​

(field) destinations: table<integer, string>

List with id of the instance that should receive the message.

id​

(field) id: string

Id of the message

name​

(field) name: string

Name of the message

on_read​

(field) on_read: fun(message: plugins.ipc.message)|nil

Optional callback executed by the receiver when the message is read.

on_reply​

(field) on_reply: fun(reply: plugins.ipc.reply)|nil

Optional callback executed when a reply to the message is received.

replies​

(field) replies: plugins.ipc.reply[]

The received replies for the message.

sender​

(field) sender: string

The id of process that sent the message

timestamp​

(field) timestamp: number

Time in seconds when the message was sent for automatic expiration purposes.

type​

(field) type: string|"message"|"method"|"signal"

Type of message.

plugins.ipc.reply​

data​

(field) data: table<string, any>

A list of named values sent back to sender.

id​

(field) id: string

Id of the message

on_read​

(field) on_read: fun(reply: plugins.ipc.reply)|nil

Optional callback executed by the sender when the reply is read.

replier​

(field) replier: string

The id of the replier

sender​

(field) sender: string

The id of process that sent the message

timestamp​

(field) timestamp: number

Time in seconds when the reply was sent for automatic expiration purposes.

plugins.ipc.sendmessageoptions​

data​

(field) data: table<string, any>

Optional data given to the receiver.

destinations​

(field) destinations: string|table<integer, string>|nil

Id of the running instances to receive the message, if not set all running instances will receive the message.

on_read​

(field) on_read: fun(message: plugins.ipc.message, reply: plugins.ipc.reply)|nil

Function executed by the message receiver.

on_reply​

(field) on_reply: fun(reply: plugins.ipc.reply)|nil

Callback that allows monitoring all the replies received for this message.

plugins.ipc.vardecl​

name​

(field) name: string

optional​

(field) optional: boolean

type​

(field) type: string

current​

function plugins.ipc.current()
  -> plugins.ipc

Get the IPC session for the running pragtical instance.

force_draw​

function plugins.ipc.force_draw()

Tell the core to force a full redraw. Should be used when receiving signals that execute draw operations while the window could be unfocused.

__call​

(method) core.object:__call(...any)
  -> core.object

Metamethod to allow using the object call as a constructor.

__tostring​

(method) core.object:__tostring()
  -> string

Metamethod to get a string representation of an object.

call​

(method) plugins.ipc:call(destinations: string|table<integer, string>|nil, name: string, ...any)
  -> return_of_called_method: any

Call a method on another instance and wait for reply.

call_async​

(method) plugins.ipc:call_async(destinations: string|table<integer, string>|nil, name: string, callback: fun(id: string, ret: table)|nil, ...any)
  -> message_id: string|nil

Call a method on another instance asynchronously waiting for the replies.

@param callback — Called with the returned values

extend​

(method) core.object:extend()
  -> core.object

extends​

(method) core.object:extends(T: any)
  -> boolean

Check if the object inherits from the given type.

get_instances​

(method) plugins.ipc:get_instances()
  -> plugins.ipc.instance[]

Get a list of running pragtical instances.

get_message​

(method) plugins.ipc:get_message(message_id: string)
  -> plugins.ipc.message|nil

Get a queued message.

get_primary_instance​

(method) plugins.ipc:get_primary_instance()
  -> string|nil

Retrieve the id of the primary instance if found.

get_reply​

(method) plugins.ipc:get_reply(message_id: string)
  -> plugins.ipc.reply|nil

Get the reply sent to a specific message.

is​

(method) core.object:is(T: any)
  -> boolean

Check if the object is strictly of the given type.

is_class_of​

(method) core.object:is_class_of(T: any)
  -> boolean

Check if the parameter is strictly of the object type.

is_extended_by​

(method) core.object:is_extended_by(T: any)
  -> boolean

Check if the parameter inherits from the object.

listen_message​

(method) plugins.ipc:listen_message(name: string, callback: fun(message: plugins.ipc.message, reply: plugins.ipc.reply)|nil, message_type?: "message"|"method"|"signal")
  -> listener_position: integer

Add a listener for a given type of message.

message_type:
    | "message"
    | "method"
    | "signal"

listen_signal​

(method) plugins.ipc:listen_signal(name: string, callback: fun(...any))
  -> listener_position: integer

Listen for a given signal.

new​

(method) plugins.ipc:new(id?: string)

Constructor

@param id — Defaults to current pragtical process id.

read_messages​

(method) plugins.ipc:read_messages()

Verify all the messages sent by running instances, read those directed to the currently running instance and reply to them.

read_replies​

(method) plugins.ipc:read_replies()
  -> plugins.ipc.reply[]|nil

Reads replies directed to messages sent by the currently running instance and if any returns them.

register_method​

(method) plugins.ipc:register_method(name: string, method: fun(...any), params?: plugins.ipc.vardecl[], returns?: plugins.ipc.vardecl[])

Add a new method that can be invoked from other instances.

@param name — A unique name for the method.

@param method — Function invoked when the method is called.

@param params — Parameters that are going to be passed into method.

@param returns — Return values of the method.

register_signal​

(method) plugins.ipc:register_signal(name: string, params?: plugins.ipc.vardecl[])

Add a new signal that can be sent to other instances.

@param name — A unique name for the signal.

@param params — Parameters that are going to be passed into callback.

remove_message​

(method) plugins.ipc:remove_message(message_id: string)

Remove a message from the queue.

send_message​

(method) plugins.ipc:send_message(name: string, options?: plugins.ipc.sendmessageoptions, message_type?: "message"|"method"|"signal")
  -> message_id: string|nil

Queue a new message to be sent to other pragtical instances.

message_type:
    | "message"
    | "method"
    | "signal"

signal​

(method) plugins.ipc:signal(destinations: string|table<integer, string>|nil, name: string, ...any)

Broadcast a signal to running instances.

start​

(method) plugins.ipc:start()

Starts and registers the ipc session and monitoring.

stop​

(method) plugins.ipc:stop()

Stop and unregister the ipc session and monitoring.

update_status​

(method) plugins.ipc:update_status()

Updates the session status of an IPC object.

wait_for_messages​

(method) plugins.ipc:wait_for_messages()

Blocks execution of current instance to wait for all messages to be replied to.

wait_for_replies​

(method) plugins.ipc:wait_for_replies(message_id: string)
  -> plugins.ipc.reply[]|nil

Blocks execution of current instance to wait for all replies by the specified message and when finished returns them.