[ External Interface | The ECLiPSe Built-In Predicates | Reference Manual | Alphabetic Index ]

peer_get_property(++Peer, ?Property, ?Value)

Returns the properties of the peer Peer.

Peer: Peer name (atom).
Property: Property name (atom or variable).
Value: Value of property Property for Peer.

Calling Modes

peer_get_property(++, ++, ?)
peer_get_property(++, -, -)

Description

If Property is a variable, this predicate will enumerate on backtracking all the properties of peer Peer. If Property is instantiated to a valid property name, the value of the property for Peer is unified with Value.

Property is one of the following:

   type     peer type (remote or embed)
   lang     peer language (currently "tcl" or "java")
   connect  connection information. Either:
               remote(LocalHost,PeerHost,TimeOut) or
               embed(Host,Host,block)
   queues   current peer queues (list of stream ids)

'connect' returns the information on the connection for the peer. This information is mainly relevant only for remote peers, but is provided for the embedded peer for compatibility. The arguments for the remote and embedded cases are equivalent, and are:

       LocalHost   Host for the ECLiPSe side
       PeerHost    Host for the Peer
       TimeOut     Time-out interval for creating new peer queues

For remote peers, the LocalHost is either the hostname of the machine or the atom 'localhost'. PeerHost is either the hostname of the machine the peer is running on, or the atom 'localhost'. 'localhost' restricts the two sides to run on the same machine. TimeOut is the time-out interval (in seconds) for accepting peer queues, or the atom 'block' if there is no time-limit.

The LocalHost and PeerHost are identical for the embedded peer, and is the hostname Host of the machine. There are no time-outs, so TimeOut argument is the the atom 'block'.

Fail Conditions

Peer is not a current peer; Property is not a valid property.

Resatisfiable

Yes.

Exceptions