Core

RPC

RPC service/client helper.

1 public methods · 4 nested API groups

Import

from Xenonix.Core import RPC

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

This object does not expose a public Config table.

Public methods

Key

Runs the Key operation for RPC.

Key(Size=32)

Arguments

Argument	Default	Accepted values	What it does
`Size`	`32`	Any valid value	Size value used by the operation or widget.

Output

Returns the calculated result.

Nested APIs

These are public helper types grouped under the main class.

Server

Server API available from the Core library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Server instance.

Create(Port, IP='127.0.0.1', Name=False, Protocol='STREAM', Thread=None, Type='TCPIP', Key=None, Workers=None, Drop=False)

Arguments

Argument	Default	Accepted values	What it does
`Port`	Required	Any valid value	Port value used by the operation.
`IP`	`'127.0.0.1'`	Any valid value	IP value used by the operation.
`Name`	`False`	Any valid value	Display/name identifier.
`Protocol`	`'STREAM'`	Any valid value	Protocol value used by the operation.
`Thread`	`None`	Any valid value	Thread value used by the operation.
`Type`	`'TCPIP'`	Any valid value	Type value used by the operation.
`Key`	`None`	Any valid value	Key value used by the operation.
`Workers`	`None`	Any valid value	Workers value used by the operation.
`Drop`	`False`	Any valid value	Turns drop on or off.

Output

Creates a new Server object.

Key

Runs the Key operation for Server.

Key(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns the calculated result.

Start

Starts the process or connection.

Start()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Method

Runs the Method operation for Server.

Method(Function, Name=None)

Arguments

Argument	Default	Accepted values	What it does
`Function`	Required	Any valid value	Function value used by the operation.
`Name`	`None`	Any valid value	Display/name identifier.

Output

Runs the operation. Some methods update the object in place.

Object

Runs the Object operation for Server.

Object(Object, Path='', Sep='.', Seen=None)

Arguments

Argument	Default	Accepted values	What it does
`Object`	Required	Any valid value	Object value used by the operation.
`Path`	`''`	Any valid value	File path used for reading or writing.
`Sep`	`'.'`	Any valid value	Sep value used by the operation.
`Seen`	`None`	Any valid value	Seen value used by the operation.

Output

Returns the calculated result.

Close

Applies a morphology-style image operation.

Close()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Client

Client API available from the Core library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Client instance.

Create(Port, IP='127.0.0.1', Name=False, Timeout=1, Protocol='STREAM', Type='TCPIP', Key=None)

Arguments

Argument	Default	Accepted values	What it does
`Port`	Required	Any valid value	Port value used by the operation.
`IP`	`'127.0.0.1'`	Any valid value	IP value used by the operation.
`Name`	`False`	Any valid value	Display/name identifier.
`Timeout`	`1`	Any valid value	Timeout value used by the operation.
`Protocol`	`'STREAM'`	Any valid value	Protocol value used by the operation.
`Type`	`'TCPIP'`	Any valid value	Type value used by the operation.
`Key`	`None`	Any valid value	Key value used by the operation.

Output

Creates a new Client object.

Key

Runs the Key operation for Client.

Key(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns the calculated result.

Object

Runs the Object operation for Client.

Object(Path)

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.

Output

Returns the calculated result.

Response

Runs the Response operation for Client.

Response(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns the calculated result.

Thread

Runs the Thread operation for Client.

Thread(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns the calculated result.

Close

Applies a morphology-style image operation.

Close()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Remote_Namespace

Remote_Namespace API available from the Core library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Remote_Namespace instance.

Create(Client, Path='')

Arguments

Argument	Default	Accepted values	What it does
`Client`	Required	Any valid value	Client value used by the operation.
`Path`	`''`	Any valid value	File path used for reading or writing.

Output

Creates a new Remote_Namespace object.

FTP

FTP helper.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new FTP instance.

Create(Target, Save_Dir='.')

Arguments

Argument	Default	Accepted values	What it does
`Target`	Required	Any valid value	Target value used by the operation.
`Save_Dir`	`'.'`	Any valid value	Save Dir value used by the operation.

Output

Creates a new FTP object.

Add

Adds a new item to the object or UI.

Add(Username, Password, Read=True, Write=False, Home='.')

Arguments

Argument	Default	Accepted values	What it does
`Username`	Required	Any valid value	Username value used by the operation.
`Password`	Required	Any valid value	Password value used by the operation.
`Read`	`True`	Any valid value	Turns read on or off.
`Write`	`False`	Any valid value	Turns write on or off.
`Home`	`'.'`	Any valid value	Home value used by the operation.

Output

Runs the operation. Some methods update the object in place.

Login

Runs the Login operation for FTP.

Login(Username, Password)

Arguments

Argument	Default	Accepted values	What it does
`Username`	Required	Any valid value	Username value used by the operation.
`Password`	Required	Any valid value	Password value used by the operation.

Output

Returns the calculated result.

Logout

Runs the Logout operation for FTP.

Logout()

Arguments

No arguments.

Output

Returns the calculated result.

Upload

Runs the Upload operation for FTP.

Upload(File_Path, Remote_Path='.', Callback=None)

Arguments

Argument	Default	Accepted values	What it does
`File_Path`	Required	Any valid value	File Path value used by the operation.
`Remote_Path`	`'.'`	Any valid value	Remote Path value used by the operation.
`Callback`	`None`	Any valid value	Optional callback function called during processing.

Output

Returns structured data such as a list or dictionary.

Download

Runs the Download operation for FTP.

Download(Remote_Path, Save_Dir='.', Callback=None)

Arguments

Argument	Default	Accepted values	What it does
`Remote_Path`	Required	Any valid value	Remote Path value used by the operation.
`Save_Dir`	`'.'`	Any valid value	Save Dir value used by the operation.
`Callback`	`None`	Any valid value	Optional callback function called during processing.

Output

Returns structured data such as a list or dictionary.

List

Runs the List operation for FTP.

List(Path='.')

Arguments

Argument	Default	Accepted values	What it does
`Path`	`'.'`	Any valid value	File path used for reading or writing.

Output

Returns the calculated result.

Size

Runs the Size operation for FTP.

Size(Path, Type='B')

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.
`Type`	`'B'`	Any valid value	Type value used by the operation.

Output

Returns the calculated result.

Delete

Removes the requested item.

Delete(Path)

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.

Output

Returns the calculated result.

Create

Runs the Create operation for FTP.

Create(Path)

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.

Output

Returns the calculated result.

Rename

Runs the Rename operation for FTP.

Rename(Old_Path, New_Path)

Arguments

Argument	Default	Accepted values	What it does
`Old_Path`	Required	Any valid value	Old Path value used by the operation.
`New_Path`	Required	Any valid value	New Path value used by the operation.

Output

Returns the calculated result.

Exists

Runs the Exists operation for FTP.

Exists(Path)

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.

Output

Returns the calculated result.

Info

Runs the Info operation for FTP.

Info(Path)

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.

Output

Returns the calculated result.