cothread.cadef
index
/dls_sw/prod/common/python/cothread/1-12/cothread/cadef.py

Functions imported directly from libca.
 
See http://he3.dartmouth.edu/manuals/CAref.html for detailed documentation
of the functions below.
 
Actually, see http://www.aps.anl.gov/epics/base/R3-14/8-docs/CAref.html
 
This module is a thin wrapper over the cadef.h file to be found in
    /dls_sw/epics/R3.14.8.2/base/include/cadef.h

 
Modules
       
ctypes

 
Classes
       
_ctypes.Structure(_ctypes._CData)
ca_connection_handler_args
event_handler_args
exception_handler_args
exceptions.Exception
CAException
Disconnected

 
class CAException(exceptions.Exception)
    Exception in response to calling ca_ method.
 
  Methods defined here:
__init__(self, status, function)
__str__(self)

Methods inherited from exceptions.Exception:
__getitem__(...)

 
class Disconnected(exceptions.Exception)
    The channel is disconnected.
 
  Methods defined here:
__init__(self, chid)
__str__(self)

Methods inherited from exceptions.Exception:
__getitem__(...)

 
class ca_connection_handler_args(_ctypes.Structure)
    # Connection handler, used to report channel connection status.
 
 
Method resolution order:
ca_connection_handler_args
_ctypes.Structure
_ctypes._CData
__builtin__.object

Data and other attributes defined here:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ca_connection_handler_args' objects>
list of weak references to the object (if defined)
chid = <Field type=c_void_p, ofs=0, size=4>
Structure/Union member
op = <Field type=c_long, ofs=4, size=4>
Structure/Union member

Methods inherited from _ctypes.Structure:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from _ctypes.Structure:
__new__ = <built-in method __new__ of _ctypes.StructType object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from _ctypes._CData:
__ctypes_from_outparam__(...)
__hash__(...)
x.__hash__() <==> hash(x)

 
class event_handler_args(_ctypes.Structure)
    # Event handler for ca_array_get_callback, ca_array_put_callback,
# ca_create_subscription.  The event handler is called when the action
# completes or the data is available.
 
 
Method resolution order:
event_handler_args
_ctypes.Structure
_ctypes._CData
__builtin__.object

Data and other attributes defined here:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'event_handler_args' objects>
list of weak references to the object (if defined)
chid = <Field type=c_long, ofs=4, size=4>
Structure/Union member
count = <Field type=c_long, ofs=12, size=4>
Structure/Union member
raw_dbr = <Field type=c_void_p, ofs=16, size=4>
Structure/Union member
status = <Field type=c_long, ofs=20, size=4>
Structure/Union member
type = <Field type=c_long, ofs=8, size=4>
Structure/Union member
usr = <Field type=py_object, ofs=0, size=4>
Structure/Union member

Methods inherited from _ctypes.Structure:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from _ctypes.Structure:
__new__ = <built-in method __new__ of _ctypes.StructType object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from _ctypes._CData:
__ctypes_from_outparam__(...)
__hash__(...)
x.__hash__() <==> hash(x)

 
class exception_handler_args(_ctypes.Structure)
    Exception handler, called to report asynchronous errors that have no other
# report path.
 
 
Method resolution order:
exception_handler_args
_ctypes.Structure
_ctypes._CData
__builtin__.object

Data and other attributes defined here:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'exception_handler_args' objects>
list of weak references to the object (if defined)
addr = <Field type=c_void_p, ofs=16, size=4>
Structure/Union member
chid = <Field type=c_void_p, ofs=4, size=4>
Structure/Union member
count = <Field type=c_long, ofs=12, size=4>
Structure/Union member
ctx = <Field type=c_char_p, ofs=28, size=4>
Structure/Union member
lineNo = <Field type=c_long, ofs=36, size=4>
Structure/Union member
op = <Field type=c_long, ofs=24, size=4>
Structure/Union member
pFile = <Field type=c_char_p, ofs=32, size=4>
Structure/Union member
stat = <Field type=c_long, ofs=20, size=4>
Structure/Union member
type = <Field type=c_long, ofs=8, size=4>
Structure/Union member
usr = <Field type=c_void_p, ofs=0, size=4>
Structure/Union member

Methods inherited from _ctypes.Structure:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from _ctypes.Structure:
__new__ = <built-in method __new__ of _ctypes.StructType object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from _ctypes._CData:
__ctypes_from_outparam__(...)
__hash__(...)
x.__hash__() <==> hash(x)

 
Functions
       
convert_py_object(object, function, args)
# We set things up so that the data type returned by ca_puser() below is a
# Python object (to be precise, the argument passed in to ca_create_channel),
# but this means that we need to get the reference counting right.
#    The ctypes library assumes when a routine returns a py_object type that
# the called routine has already incremented the object's reference count.
# If the object is just a void* then this isn't going to be so: this routine
# when assigned to errcheck will resolve this problem.
expect_ECA_NORMAL(status, function, args)
# For routines which are simply expected to succeed this routine should be
# assigned to the routine's errcheck attribute.
expect_connected(sentinel, chid=0)
sentinel is the disconnected notification value to check for, and chid
is the position in the argument list of the channel being inspected.

 
Data
        CA_OP_ADD_EVENT = 3
CA_OP_CLEAR_EVENT = 4
CA_OP_CONN_DOWN = 7
CA_OP_CONN_UP = 6
CA_OP_CREATE_CHANNEL = 2
CA_OP_GET = 0
CA_OP_OTHER = 5
CA_OP_PUT = 1
DBE_ALARM = 4
DBE_LOG = 2
DBE_VALUE = 1
ECA_16KARRAYCLIENT = 464
ECA_ADDFAIL = 168
ECA_ALLOCMEM = 48
ECA_ANACHRONISM = 386
ECA_BADCHID = 410
ECA_BADCOUNT = 176
ECA_BADFUNCPTR = 418
ECA_BADMASK = 330
ECA_BADMONID = 242
ECA_BADPRIORITY = 450
ECA_BADSTR = 186
ECA_BADSYNCGRP = 354
ECA_BADTYPE = 114
ECA_BUILDGET = 216
ECA_CHANDESTROY = 440
ECA_CHIDNOTFND = 123
ECA_CHIDRETRY = 131
ECA_CONN = 40
ECA_CONNSEQTMO = 472
ECA_DBLCHNL = 200
ECA_DBLCLFAIL = 144
ECA_DEFUNCT = 278
ECA_DISCONN = 192
ECA_DISCONNCHID = 106
ECA_DLCKREST = 304
ECA_EMPTYSTR = 280
ECA_EVDISALLOW = 210
ECA_GETFAIL = 152
ECA_INTERNAL = 142
ECA_IODONE = 339
ECA_IOINPROGRESS = 347
ECA_ISATTACHED = 424
ECA_MAXIOC = 10
ECA_NEEDSFP = 224
ECA_NEWADDR = 248
ECA_NEWCONN = 259
ECA_NOCACTX = 264
ECA_NOCAST = 320
ECA_NOCHANMSG = 296
ECA_NOCONVERT = 400
ECA_NORDACCESS = 368
ECA_NOREPEATER = 288
ECA_NORMAL = 1
ECA_NOSEARCHADDR = 392
ECA_NOSUPPORT = 88
ECA_NOTTHREADED = 458
ECA_NOWTACCESS = 376
ECA_OVEVFAIL = 232
ECA_PUTCBINPROG = 362
ECA_PUTFAIL = 160
ECA_SERVBEHIND = 312
ECA_SOCK = 34
ECA_STRTOBIG = 96
ECA_TIMEOUT = 80
ECA_TOLARGE = 72
ECA_UKNCHAN = 56
ECA_UKNFIELD = 64
ECA_UKNHOST = 18
ECA_UKNSERV = 26
ECA_UNAVAILINSERV = 432
ECA_UNRESPTMO = 480
TYPENOTCONN = -1
ca_add_exception_event = <_FuncPtr object>
ca_add_fd_registration = <_FuncPtr object>
ca_array_get_callback = <_FuncPtr object>
ca_array_put = <_FuncPtr object>
ca_array_put_callback = <_FuncPtr object>
ca_attach_context = <_FuncPtr object>
ca_clear_channel = <_FuncPtr object>
ca_clear_subscription = <_FuncPtr object>
ca_context_create = <_FuncPtr object>
ca_context_destroy = <_FuncPtr object>
ca_create_channel = <_FuncPtr object>
ca_create_subscription = <_FuncPtr object>
ca_current_context = <_FuncPtr object>
ca_element_count = <_FuncPtr object>
ca_field_type = <_FuncPtr object>
ca_flush_io = <_FuncPtr object>
ca_message = <_FuncPtr object>
ca_name = <_FuncPtr object>
ca_pend_event = <_FuncPtr object>
ca_puser = <_FuncPtr object>
ca_state = <_FuncPtr object>
cs_closed = 3
cs_conn = 2
cs_never_conn = 0
cs_prev_conn = 1
libca = <CDLL '/dls_sw/epics/R3.14.8.2/base/lib/linux-x86/libca.so', handle 9c04fc8 at b7d1298c>