central-client

VIRTUTECH CONFIDENTIAL Previous - Up - Next

central-client

Provided by: central
Class Hierarchy: conf-object → log-object → central-client
Interfaces Implemented: log_object, event_poster
Description: This class handles communication and synchronization for distributed simulation.

Attributes

Attributes inherited from class conf-object

attributes, classname, component, iface, name, object_id, queue

Attributes inherited from class log-object

access_count, log_buffer, log_buffer_last, log_buffer_size, log_group_mask, log_groups, log_level, log_type_mask

Attribute List

central_host: Pseudo class attribute; read/write access; type: s|n.
Internal attribute.

connect_at_startup: Pseudo class attribute; read/write access; type: Integer.
Internal attribute.

connected: Pseudo attribute; read/write access; type: Integer.
Is this object connected to the Central server? This attribute is 1 if a connection has been established, and 0 if no connection is configured, or the connection failed. The server attribute contains the address of the server to connect to. This attribute can be set to 0 to disconnect to server, or to 1 to reconnect to the server if the connection was lost or the initial connection attempt failed. Setting it to 1 when the server attribute is nil is not allowed.

description: Optional attribute; read/write access; type: String.
A description string that can be used to identify this Simics instance.

links: Pseudo attribute; read-only access; type: [[io]*].
The link objects that have registered in this Simics process. This is a list where each element is a list (id, obj). The id is the global ID number for the link, and obj is the link object in this Simics instance. If the Central client is not connected to a server, a local ID number will be given instead of global ID number.

reconnect: Optional attribute; read/write access; type: Integer.
This attribute controls whether the Central client will automatically try to reconnect to the Central server if the connection is lost, or if it fails to establish an initial connection. A value of 0 means that reconnection is disabled, and a value greater than 0 means that the client will retry after this many seconds.

server: Optional attribute; read/write access; type: s|o|n.
The Central server to connect to. When set, the client will attempt to connect to the server immediately, but even if the connection fails, setting this attribute won't fail. The connected attribute can be used to check if the connection was successful. Also see the reconnect attribute.

syncstate: Optional attribute; read/write access; type: [i[ii][ii][ii]]|n.
The synchronization state.

Command List

Commands defined by interface log_object

log, log-group, log-level, log-size, log-type

Commands

connect	connect to Simics Central
disconnect	disconnect from Simics Central
info	print information about the device
links	list connected links

Command Descriptions

<central-client>.connect

Synopsis

<central-client>.connect ("server"|obj)

Description

Connect Simics to a Simics Central server.

The server argument specifies the server to connect to. It is either of the form <addr>[:<port>] if a TCP connection should be used, or a file name if a file socket should be used.

To connect to a server object in the same Simics, use the obj argument instead.

<central-client>.disconnect
Synopsis: <central-client>.disconnect
Description: Disconnect from the Simics Central server.
This will make this Simics process standalone, and no longer part of a distributed simulation session.
See Also: connect-central, new-central-server, <central-client>.connect

<central-client>.info
Synopsis: <central-client>.info
Description: Print detailed information about the configuration of the device.

<central-client>.links
Synopsis: <central-client>.links
Description: List the link objects in this process that are shared in a distributed session.
When connected to a Simics Central, the link object in this list will be distributed.

VIRTUTECH CONFIDENTIAL Previous - Up - Next