EvtCliIO Class Reference

Event client input/output class. More...

Inheritance diagram for EvtCliIO:

[legend]Collaboration diagram for EvtCliIO:

[legend]List of all members.

Public Member Functions
	__init__ (debug, port=PortNumber)
	connect (host, force=False)
	setSocket (sock)
	readSocket ()
	The 'lightweight' event read routine.
	readFile ()
	Read the event from a file.
	open (filename, mode="r+b")
	Open the event archive file for input.
	close ()
	Close the event source file.
	abort ()
	Abort out of a readEvent().
	setTimeoutEnabled (flag)
	Enable or disable event timeout.
	isTimeoutEnabled ()
	Checks the event timeout state.
	setTimeout (timeout=1.0)
	Set the timeout value.
	getTimeout ()
	Query the current timeout value.
	unpack (fmt, str)
	Wrapper method for unpack.

---

Detailed Description

Event client input/output class.

Contents:

This base class contains all the input/output handling routines for the event client (EvtCli) class.

Definition at line 622 of file gEvtCli.py.

---

Member Function Documentation

abort (   )

Abort out of a readEvent(). Can be used from another thread

getTimeout (   )

Query the current timeout value. Returns: Current event timeout value as a floating point number in seconds

isTimeoutEnabled (   )

Checks the event timeout state. Returns: 1 = If event timeout is enabled 0 = If event timeout is disabled

open (  filename  , mode  = "r+b" )

Open the event archive file for input. Parameters: filename  Event archive file name

readSocket (   )

The 'lightweight' event read routine. This routine does the minimal work of reading the raw event data from a file or a socket. Returns: Event buffer read

setTimeout (  timeout  = 1.0  )

Set the timeout value. Parameters: timeout  Event timeout value as a floating point number in seconds. Default is 1 second. Use 'None' to disable the timeout.

setTimeoutEnabled (  flag   )

Enable or disable event timeout. Parameters: flag  1 = Enable event timeout 0 = Disable event timeout (default)

unpack (  fmt  , str  )

Wrapper method for unpack. Parameters: fmt  Unpack format str  String to be unpacked Returns: Unpacked data tuple

---

The documentation for this class was generated from the following file:

• gEvtCli.py

---