Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve labrad doc string for 'Connection Info' setting. #64

Merged
merged 2 commits into from
Jul 27, 2016

Conversation

maffoo
Copy link
Contributor

@maffoo maffoo commented Jul 26, 2016

Setting info in pylabrad now looks like this:

In [3]: cxn.manager.connection_info
Out[3]: 
LabRAD Setting: "Manager" >> "Connection Info" (ID=10000)

Get information about connected servers and clients.

Returns a list of clusters, one for each connection. Each cluster
contains the following elements:
 - id: The connection id (pass to `Close Connection` to kill connection.
 - name: The connection name.
 - is_server: Boolean indicating if this is a server (true) or client (false).
 - server_requests: Number of requests received by server (meaningless for clients).
 - server_replies: Number of replies sent by server (meaningless for clients).
 - client_requests: Number of requests sent by client or server.
 - client_replies: Number of replies received by client or server.
 - messages_sent: Number of messages sent by client or server.
 - messages_received: Number of messages received by client or server.

Accepts:
    _

Returns:
    *(wsbwwwwww)

Fixes #62

@ejeffrey

@ejeffrey
Copy link

LGTM

@maffoo maffoo merged commit 2f3a5d9 into master Jul 27, 2016
@maffoo maffoo deleted the u/maffoo/connection-info-doc branch July 27, 2016 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants