summaryrefslogtreecommitdiff
path: root/libvxi11client/perlbits/README
diff options
context:
space:
mode:
authordaniel <danieruru@gmail.com>2013-01-23 13:17:52 +0900
committerdaniel <danieruru@gmail.com>2013-01-23 13:17:52 +0900
commitc53ea096ab5a656f93ad2aed8d50f5dd346f91c3 (patch)
tree5dbd48863285fe0a6f6f19fbd4b916d6ce7b4cde /libvxi11client/perlbits/README
parent63f018d9d0a4b1ae11f9adb6f5bd3c9315b00130 (diff)
Update docs, add the "global" functions to the export list, add the reason from read to the stuff that gets returned.
Diffstat (limited to 'libvxi11client/perlbits/README')
-rw-r--r--libvxi11client/perlbits/README20
1 files changed, 0 insertions, 20 deletions
diff --git a/libvxi11client/perlbits/README b/libvxi11client/perlbits/README
index ba3e278..d036787 100644
--- a/libvxi11client/perlbits/README
+++ b/libvxi11client/perlbits/README
@@ -4,26 +4,6 @@ VXI11-Client version 0.01
This module is a wrapper around a C library that uses libc's built in
Sun RPC support to talk to VXI11 networked instruments.
-It supports only one instrument at a time.
-
-Interrupts work by creating the interrupt channel, enabling interrupts
-and then using wait_for_interrupt() to wait for an interrupt to happen.
-wait_for_interrupt() blocks until a interrupt happens or a timeout occurs.
-If an interrupt happens before it is called it returns immediately.
-If multiple interrupts happen before it is called it will return immediately
-until all the fired interrupts are cleared.
-
-Return codes work like this;
-1 - is a success
-0 - means the request failed locally, the state inside the client is
-incorrect, i.e. calling to enable interrupts before creating the channel
-or that the server couldn't be contacted
-< 0 - Any negative value is the negated VXI-11 error code from the server
-
-The only exceptions to this are the read and write methods
-0 - Error as above or zero bytes read/written
-> 0 - Number of bytes read/written
-
INSTALLATION
To install this module type the following: