Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ClientRepositoryBase Class Reference
Inheritance diagram for ClientRepositoryBase:
ConnectionRepository DoInterestManager DoCollectionManager CConnectionRepository ClientRepository

Public Member Functions

def __init__ (self, dcFileNames=None, dcSuffix='', connectMethod=None, threadedNet=None)
def allocateContext (self)
def considerHeartbeat (self)
def disableDoId (self, doId, ownerView=False)
def doDeferredGenerate (self, task)
def doGenerate (self, parentId, zoneId, classId, doId, di)
def flushGenerates (self)
def generateWithRequiredFields (self, dclass, doId, di, parentId, zoneId)
def generateWithRequiredOtherFields (self, dclass, doId, di, parentId=None, zoneId=None)
def generateWithRequiredOtherFieldsOwner (self, dclass, doId, di)
def getObjectsOfClass (self, objClass)
def getObjectsOfExactClass (self, objClass)
def getServerDelta (self)
def getServerTimeOfDay (self)
def getTables (self, ownerView)
def getWorld (self, doId)
def handleDelete (self, di)
def handleGoGetLost (self, di)
def handleServerHeartbeat (self, di)
def handleSystemMessage (self, di)
def handleSystemMessageAknowledge (self, di)
def handleUpdateField (self, di)
def isLive (self)
def isLocalId (self, id)
def printDelayDeletes (self)
def replaceMethod (self, oldMethod, newFunction)
def replayDeferredGenerate (self, msgType, extra)
def sendHeartbeatTask (self, task)
def setDeferInterval (self, deferInterval)
def setServerDelta (self, delta)
def specialName (self, label)
 def queryObjectAll(self, doID, context=0): """ Get a one-time snapshot look at the object. More...
def startHeartbeat (self)
def stopHeartbeat (self)
def waitForNextHeartBeat (self)
- Public Member Functions inherited from ConnectionRepository
def checkHttp (self)
def connect (self, serverList, successCallback=None, successArgs=[], failureCallback=None, failureArgs=[])
def disconnect (self)
def generateGlobalObject (self, doId, dcname, values=None)
def getServerAddress (self)
def handleDatagram (self, di)
def handleReaderOverflow (self)
def httpConnectCallback (self, ch, serverList, serverIndex, successCallback, successArgs, failureCallback, failureArgs)
def importModule (self, dcImports, moduleName, importSymbols)
def lostConnection (self)
def readDCFile (self, dcFileNames=None)
def readerPollOnce (self)
def readerPollUntilEmpty (self, task)
def send (self, datagram)
def shutdown (self)
def startReaderPollTask (self)
def stopReaderPollTask (self)
- Public Member Functions inherited from DoInterestManager
def __init__ (self)
def addAutoInterest (self, parentId, zoneIdList, description)
def addInterest (self, parentId, zoneIdList, description, event=None)
def alterInterest (self, handle, parentId, zoneIdList, description=None, event=None)
def cleanupWaitAllInterestsComplete (self)
def closeAutoInterests (self, obj)
def getAllInterestsCompleteEvent (self)
def handleInterestDoneMessage (self, di)
def isValidInterestHandle (self, handle)
def noNewInterests (self)
def openAutoInterests (self, obj)
def printInterestHistory (self)
def printInterests (self)
def printInterestSets (self)
def printInterestsIfDebug (self)
def queueAllInterestsCompleteEvent (self, frames=5)
def removeAIInterest (self, handle)
def removeAutoInterest (self, handle)
def removeInterest (self, handle, event=None)
def resetInterestStateForConnectionLoss (self)
def setAllInterestsCompleteCallback (self, callback)
def setNoNewInterests (self, flag)
def updateInterestDescription (self, handle, desc)
- Public Member Functions inherited from DoCollectionManager
def __init__ (self)
def addDOToTables (self, do, location=None, ownerView=False)
def callbackWithDo (self, doId, callback)
def callbackWithOwnerView (self, doId, callback)
def countObjects (self, classType)
def deleteDistributedObjects (self)
def deleteObjectLocation (self, object, parentId, zoneId)
def doByDistance (self)
def doFind (self, str)
def doFindAll (self, str)
def doFindAllInstances (self, cls)
def doFindAllMatching (self, str)
def doFindAllOfType (self, query)
def dosByDistance (self)
def findAnyOfType (self, type)
def getAllOfType (self, type)
def getDo (self, doId)
def getDoIdList (self, parentId, zoneId=None, classType=None)
def getDoList (self, parentId, zoneId=None, classType=None)
def getDoTable (self, ownerView)
def getGameDoId (self)
def getObjectsInZone (self, parentId, zoneId)
 def changeDOZoneInTables(self, do, newParentId, newZoneId, oldParentId, oldZoneId): if 1: self.storeObjectLocation(do.doId, newParentId, newZoneId) else: #assert not hasattr(do, "isQueryAllResponse") or not do.isQueryAllResponse oldLocation = (oldParentId, oldZoneId) newLocation = (newParentId, newZoneId) More...
def getObjectsOfClassInZone (self, parentId, zoneId, objClass)
def getOwnerView (self, doId)
def getOwnerViewDoIdList (self, classType)
def getOwnerViewDoList (self, classType)
def handleObjectLocation (self, di)
def handleSetLocation (self, di)
def hasOwnerViewDoId (self, doId)
def isInDoTables (self, doId)
def isValidLocationTuple (self, location)
def printObjectCount (self)
def printObjects (self)
def removeDOFromTables (self, do)
def storeObjectLocation (self, object, parentId, zoneId)
def webPrintObjectCount (self)
- Public Member Functions inherited from CConnectionRepository
 __init__ (bool has_owner_view, bool threaded_net)
 abandonMessageBundles ()
 throw out any msgs that have been queued up for message bundles More...
 bundleMsg (const Datagram dg)
bool checkDatagram ()
 Returns true if a new datagram is available, false otherwise. More...
bool connectNative (const URLSpec url)
 Connects to the server using Panda's low-level and fast "native net" library. More...
bool considerFlush ()
 Sends the most recently queued data if enough time has elapsed. More...
 disconnect ()
 Closes the connection to the server. More...
bool flush ()
 Sends the most recently queued data now. More...
BufferedDatagramConnection getBdc ()
 Returns the Buffered_DatagramConnection object associated with the repository. More...
bool getClientDatagram ()
 Returns the client_datagram flag. More...
ConnectionWriter getCw ()
 Returns the ConnectionWriter object associated with the repository. More...
 getDatagram (Datagram dg)
 Fills the datagram object with the datagram most recently retrieved by check_datagram(). More...
 getDatagramIterator (DatagramIterator di)
 Fills the DatagramIterator object with the iterator for the datagram most recently retrieved by check_datagram(). More...
DCFile getDcFile ()
 Returns the DCFile object associated with this repository. More...
bool getHandleCUpdates ()
 Returns true if this repository will process distributed updates internally in C++ code, or false if it will return them to Python. More...
bool getHandleDatagramsInternally ()
 Returns the handle_datagrams_internally flag. More...
bool getInQuietZone ()
 Returns true if repository is in quiet zone mode. More...
CHANNELTYPE getMsgChannel (int offset)
 Returns the channel(s) to which the current message was sent, according to the datagram headers. More...
int getMsgChannelCount ()
CHANNELTYPE getMsgSender ()
 Returns the sender ID of the current message, according to the datagram headers. More...
unsigned int getMsgType ()
 Returns the type ID of the current message, according to the datagram headers. More...
QueuedConnectionManager getQcm ()
 Returns the QueuedConnectionManager object associated with the repository. More...
QueuedConnectionReader getQcr ()
 Returns the QueuedConnectionReader object associated with the repository. More...
bool getSimulatedDisconnect ()
 Returns the simulated disconnect flag. More...
SocketStream getStream ()
 Returns the SocketStream that internally represents the already-established HTTP connection. More...
int getTcpHeaderSize ()
 Returns the current setting of TCP header size. More...
float getTimeWarning ()
 Returns the current setting of the time_warning field. More...
bool getVerbose ()
 Returns the current setting of the verbose flag. More...
bool getWantMessageBundling ()
 Returns true if message bundling enabled. More...
bool hasOwnerView ()
 Returns true if this repository can have 'owner' views of distributed objects. More...
bool isBundlingMessages ()
 Returns true if repository is queueing outgoing messages into a message bundle. More...
bool isConnected ()
 Returns true if the connection to the gameserver is established and still good, false if we are not connected. More...
bool sendDatagram (const Datagram dg)
 Queues the indicated datagram for sending to the server. More...
 sendMessageBundle (unsigned int channel, unsigned int sender_channel)
 Send network messages queued up since startMessageBundle was called. More...
 setClientDatagram (bool client_datagram)
 Sets the client_datagram flag. More...
 setConnectionHttp (HTTPChannel channel)
 Once a connection has been established via the HTTP interface, gets the connection and uses it. More...
 setHandleCUpdates (bool handle_c_updates)
 Set true to specify this repository should process distributed updates internally in C++ code, or false if it should return them to Python. More...
 setHandleDatagramsInternally (bool handle_datagrams_internally)
 Sets the handle_datagrams_internally flag. More...
 setInQuietZone (bool flag)
 Enables/disables quiet zone mode. More...
 setPythonRepository (object python_repository)
 Records the pointer to the Python class that derives from CConnectionRepository. More...
 setSimulatedDisconnect (bool simulated_disconnect)
 Sets the simulated disconnect flag. More...
 setTcpHeaderSize (int tcp_header_size)
 Sets the header size of TCP packets. More...
 setTimeWarning (float time_warning)
 Directly sets the time_warning field. More...
 setVerbose (bool verbose)
 Directly sets the verbose flag. More...
 setWantMessageBundling (bool flag)
 Enable/disable outbound message bundling. More...
 shutdown ()
 May be called at application shutdown to ensure all threads are cleaned up. More...
 startMessageBundle ()
 Send a set of messages to the state server that will be processed atomically. More...
 toggleVerbose ()
 Toggles the current setting of the verbose flag. More...
bool tryConnectNet (const URLSpec url)
 Uses Panda's "net" library to try to connect to the server and port named in the indicated URL. More...

Public Attributes

- Public Attributes inherited from ConnectionRepository
 if self.recorder and self.recorder.isPlaying(): More...
- Public Attributes inherited from DoCollectionManager
 self.zoneId2doIds={} More...

Static Public Attributes

 notify = DirectNotifyGlobal.directNotify.newCategory("ClientRepositoryBase")
- Static Public Attributes inherited from ConnectionRepository
int CM_HTTP = 0
int CM_NATIVE = 2
int CM_NET = 1
string GarbageCollectTaskName = "allowGarbageCollect"
string GarbageThresholdTaskName = "adjustGarbageCollectThreshold"
 gcNotify = directNotify.newCategory("GarbageCollect")
 notify = directNotify.newCategory("ConnectionRepository")
 taskChain = None
int taskPriority = -30
- Static Public Attributes inherited from DoInterestManager
 InterestDebug = ConfigVariableBool('interest-debug', False)
 notify = directNotify.newCategory("DoInterestManager")

Additional Inherited Members

- Static Public Member Functions inherited from CConnectionRepository
static str getOverflowEventName ()
 Returns event string that will be thrown if the datagram reader queue overflows. More...

Detailed Description

This maintains a client-side connection with a Panda server.

This base class exists to collect the common code between
ClientRepository, which is the CMU-provided, open-source version
of the client repository code, and OTPClientRepository, which is
the VR Studio's implementation of the same.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  dcFileNames = None,
  dcSuffix = '',
  connectMethod = None,
  threadedNet = None 

Reimplemented from ConnectionRepository.

Reimplemented in ClientRepository.

Member Function Documentation

◆ allocateContext()

def allocateContext (   self)

◆ considerHeartbeat()

def considerHeartbeat (   self)
Send a heartbeat message if we haven't sent one recently.

◆ disableDoId()

def disableDoId (   self,
  ownerView = False 

◆ doDeferredGenerate()

def doDeferredGenerate (   self,
This is the task that generates an object on the deferred

◆ doGenerate()

def doGenerate (   self,

◆ flushGenerates()

def flushGenerates (   self)
Forces all pending generates to be performed immediately. 

◆ generateWithRequiredFields()

def generateWithRequiredFields (   self,

◆ generateWithRequiredOtherFields()

def generateWithRequiredOtherFields (   self,
  parentId = None,
  zoneId = None 

◆ generateWithRequiredOtherFieldsOwner()

def generateWithRequiredOtherFieldsOwner (   self,

◆ getObjectsOfClass()

def getObjectsOfClass (   self,
returns dict of doId:object, containing all objects
that inherit from 'class'. returned dict is safely mutable. 

◆ getObjectsOfExactClass()

def getObjectsOfExactClass (   self,
returns dict of doId:object, containing all objects that
are exactly of type 'class' (neglecting inheritance). returned
dict is safely mutable. 

◆ getServerDelta()

def getServerDelta (   self)

◆ getServerTimeOfDay()

def getServerTimeOfDay (   self)
Returns the current time of day (seconds elapsed since the
1972 epoch) according to the server's clock.  This is in GMT,
and hence is irrespective of timezones.

The value is computed based on the client's clock and the
known delta from the server's clock, which is not terribly
precisely measured and may drift slightly after startup, but
it should be accurate plus or minus a couple of seconds.

◆ getTables()

def getTables (   self,

◆ getWorld()

def getWorld (   self,

◆ handleDelete()

def handleDelete (   self,

Reimplemented in ClientRepository.

◆ handleGoGetLost()

def handleGoGetLost (   self,

◆ handleServerHeartbeat()

def handleServerHeartbeat (   self,

◆ handleSystemMessage()

def handleSystemMessage (   self,

◆ handleSystemMessageAknowledge()

def handleSystemMessageAknowledge (   self,

◆ handleUpdateField()

def handleUpdateField (   self,
This method is called when a CLIENT_OBJECT_UPDATE_FIELD
message is received; it decodes the update, unpacks the
arguments, and calls the corresponding method on the indicated

In fact, this method is exactly duplicated by the C++ method
cConnectionRepository::handle_update_field(), which was
written to optimize the message loop by handling all of the
CLIENT_OBJECT_UPDATE_FIELD messages in C++.  That means that
nowadays, this Python method will probably never be called,
since UPDATE_FIELD messages will not even be passed to the
Python message handlers.  But this method remains for
documentation purposes, and also as a "just in case" handler
in case we ever do come across a situation in the future in
which python might handle the UPDATE_FIELD message.

Reimplemented in ClientRepository.

◆ isLive()

def isLive (   self)

◆ isLocalId()

def isLocalId (   self,

Reimplemented in ClientRepository.

◆ printDelayDeletes()

def printDelayDeletes (   self)

◆ replaceMethod()

def replaceMethod (   self,

◆ replayDeferredGenerate()

def replayDeferredGenerate (   self,
Override this to do something appropriate with deferred
"generate" messages when they are replayed().

◆ sendHeartbeatTask()

def sendHeartbeatTask (   self,

◆ setDeferInterval()

def setDeferInterval (   self,
Specifies the minimum amount of time, in seconds, that must
elapse before generating any two DistributedObjects whose
class type is marked "deferrable".  Set this to 0 to indicate
no deferring will occur.

◆ setServerDelta()

def setServerDelta (   self,
Indicates the approximate difference in seconds between the
client's clock and the server's clock, in universal time (not
including timezone shifts).  This is mainly useful for
reporting synchronization information to the logs; don't
depend on it for any precise timing requirements.

Also see Notify.setServerDelta(), which also accounts for a
timezone shift.

◆ specialName()

def specialName (   self,

def queryObjectAll(self, doID, context=0): """ Get a one-time snapshot look at the object.

""" assert self.notify.debugStateCall(self)

Create a message

datagram = PyDatagram() datagram.addServerHeader( doID, localAvatar.getDoId(), 2020)

A context that can be used to index the response if needed

datagram.addUint32(context) self.send(datagram)

Make sure the message gets there.


◆ startHeartbeat()

def startHeartbeat (   self)

◆ stopHeartbeat()

def stopHeartbeat (   self)

◆ waitForNextHeartBeat()

def waitForNextHeartBeat (   self)

Member Data Documentation

◆ bootedIndex


◆ bootedText


◆ cache


◆ cacheOwner


◆ context


◆ dcSuffix


◆ deferInterval


◆ deferredDoIds


◆ deferredGenerates


◆ doDataCache


◆ heartbeatInterval


◆ heartbeatStarted


◆ lastGenerate


◆ lastHeartbeat


◆ noDefer


◆ notify

notify = DirectNotifyGlobal.directNotify.newCategory("ClientRepositoryBase")

◆ parentMgr


◆ recorder


◆ relatedObjectMgr


◆ serverDelta


◆ specialNameNumber


◆ timeManager