ancillarySocket.py

#!/usr/local/bin/python
#
#                               Copyright 2006
#                                     by
#                        The Board of Trustees of the
#                     Leland Stanford Junior University.
#                            All rights reserved.
#

__facility__ = "Online"
__abstract__ = "Read ancillary event contributions from a socket"
__author__   = "R. Claus <Claus@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "3/30/2006"
__updated__  = ("$Date: 2006/07/14 22:34:28 $").split(' ')[1]
__version__  = "$Revision: 1.1 $"
__release__  = "$Name: R04-12-00 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC

import struct
from   array                              import array
import logging                            as     log

import LATTE.merger.geb                   as     geb
from   LATTE.merger.ancillaryContribution import AncillaryContribution
from   LATTE.client.gSocket               import Socket


class AncillaryContributor(geb.GebContributor):
  __typeIds = [AncillaryContribution.HeaderId,
               AncillaryContribution.TrailerId,
               AncillaryContribution.EventId]
  def __init__(self, (host, port), offset = 0):
    geb.GebContributor.__init__(self)
    self.__socket    = Socket(port)
    self.__host      = host
    self.__fakeEvent = struct.pack("<3L", AncillaryContribution.EventId, 3*4, 0xdeadbeefL)
    self.__offset    = offset

  def name(self):
    return "Anc"

  def offset(self):
    return self.__offset

  def open(self):
    self.__socket.connect(self.__host)
    self.__socket.settimeout(9999)
    print "AncContrib.open: socket opened"

  def close(self):
    self.__socket.disconnect()

  def read(self):
    """!\brief Method to read an ancillary contribution from a file.
    """
    data   = self.__socket.recvall(8)
    (vTypeId, length) = struct.unpack('<2L', data)
    typeId = vTypeId & 0x000fffff
    if typeId not in AncillaryContributor.__typeIds:
      # Don't try to continue if bad typeId: we're lost or it's undefined
      raise KeyError, "Unrecognized contribution %08x"%(typeId)
    length &= 0x0fffffff
    #print "AncContrib.read:   id = %08x, len = %08x" % (typeId,length)
    data  += self.__socket.recvall(length - 8)
    data = array('I', data)
    data.byteswap()
    data = data.tostring()

    status = 0
    if typeId == AncillaryContribution.EventId:
      return geb.Geb.Build,     status, AncillaryContribution(self, data)
    else:
      return geb.Geb.DontBuild, status, AncillaryContribution(self, data)

  def fake(self):
    return self.__fakeEvent

---