Panda3D
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
AsyncRequest Class Reference
Inheritance diagram for AsyncRequest:
DirectObject

Public Member Functions

def __init__ (self, air, replyToChannelId=None, timeoutTime=ASYNC_REQUEST_DEFAULT_TIMEOUT_IN_SECONDS, numRetries=ASYNC_REQUEST_DEFAULT_NUM_RETRIES)
 
def askForObject (self, doId, context=None)
 
def askForObjectField (self, dclassName, fieldName, doId, key=None, context=None)
 
def askForObjectFields (self, dclassName, fieldNames, doId, key=None, context=None)
 
def askForObjectFieldsByString (self, dbId, dclassName, objString, fieldNames, key=None, context=None)
 
def createObject (self, name, className, databaseId=None, values=None, context=None)
 
def createObjectId (self, name, className, values=None, context=None)
 
def delete (self)
 
def finish (self)
 
def timeout (self, task)
 
- Public Member Functions inherited from DirectObject
def __init__ (self)
 
def accept (self, event, method, extraArgs=[])
 
def acceptOnce (self, event, method, extraArgs=[])
 
def addTask (self, *args, **kwargs)
 
def detectLeaks (self)
 
def doMethodLater (self, *args, **kwargs)
 
def getAllAccepting (self)
 
def ignore (self, event)
 
def ignoreAll (self)
 
def isAccepting (self, event)
 
def isIgnoring (self, event)
 
def removeAllTasks (self)
 
def removeTask (self, taskOrName)
 

Public Attributes

 air
 
 deletingMessage
 
 neededObjects
 
 numRetries
 
 replyToChannelId
 
 timeoutTask
 

Static Public Attributes

 notify = DirectNotifyGlobal.directNotify.newCategory('AsyncRequest')
 
- Static Public Attributes inherited from DirectObject
def accept_once = acceptOnce
 
def add_task = addTask
 
def detect_leaks = detectLeaks
 
def do_method_later = doMethodLater
 
def get_all_accepting = getAllAccepting
 
def ignore_all = ignoreAll
 
def is_accepting = isAccepting
 
def is_ignoring = isIgnoring
 
def remove_all_tasks = removeAllTasks
 
def remove_task = removeTask
 

Detailed Description

This class is used to make asynchronos reads and creates to a database.

You can create a list of self.neededObjects and then ask for each to be
read or created, or if you only have one object that you need you can
skip the self.neededObjects because calling askForObject or createObject
will set the self.neededObjects value for you.

Once all the objects have been read or created, the self.finish() method
will be called.  You may override this function to run your code in a
derived class.

If you wish to queue up several items that you all need before the finish
method is called, you can put items in self.neededObjects and then call
askForObject or createObject afterwards.  That way the _checkCompletion
will not call finish until after all the requests have been done.

If you need to chain serveral object reads or creates, just add more
entries to the self.neededObjects dictionary in the self.finish function
and return without calling AsyncRequest.finish().  Your finish method
will be called again when the new self.neededObjects is complete.  You
may repeat this as necessary.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  air,
  replyToChannelId = None,
  timeoutTime = ASYNC_REQUEST_DEFAULT_TIMEOUT_IN_SECONDS,
  numRetries = ASYNC_REQUEST_DEFAULT_NUM_RETRIES 
)
air is the AI Respository.
replyToChannelId may be an avatarId, an accountId, or a channelId.
timeoutTime is how many seconds to wait before aborting the request.
numRetries is the number of times to retry the request before giving up.

Member Function Documentation

◆ askForObject()

def askForObject (   self,
  doId,
  context = None 
)
Request an already created object, i.e. read from database.

◆ askForObjectField()

def askForObjectField (   self,
  dclassName,
  fieldName,
  doId,
  key = None,
  context = None 
)
Request an already created object, i.e. read from database.

◆ askForObjectFields()

def askForObjectFields (   self,
  dclassName,
  fieldNames,
  doId,
  key = None,
  context = None 
)
Request an already created object, i.e. read from database.

◆ askForObjectFieldsByString()

def askForObjectFieldsByString (   self,
  dbId,
  dclassName,
  objString,
  fieldNames,
  key = None,
  context = None 
)

◆ createObject()

def createObject (   self,
  name,
  className,
  databaseId = None,
  values = None,
  context = None 
)
Create a new database object.  You can get the doId from within
your self.finish() function.

This functions is different from createObjectId in that it does
generate the object when the response comes back.  The object is
added to the doId2do and so forth and treated as a full regular
object (which it is).  This is useful on the AI where we really
do want the object on the AI.

◆ createObjectId()

def createObjectId (   self,
  name,
  className,
  values = None,
  context = None 
)
Create a new database object.  You can get the doId from within
your self.finish() function.

This functions is different from createObject in that it does not
generate the object when the response comes back.  It only tells you
the doId.  This is useful on the UD where we don't really want the
object on the UD, we just want the object created and the UD wants
to send messages to it using the ID.

◆ delete()

def delete (   self)

◆ finish()

def finish (   self)
This is the function that gets called when all of the needed objects
are in (i.e. all the askForObject and createObject requests have
been satisfied).
If the other requests timeout, finish will not be called.

◆ timeout()

def timeout (   self,
  task 
)

Member Data Documentation

◆ air

air

◆ deletingMessage

deletingMessage

◆ neededObjects

neededObjects

◆ notify

notify = DirectNotifyGlobal.directNotify.newCategory('AsyncRequest')
static

◆ numRetries

numRetries

◆ replyToChannelId

replyToChannelId

◆ timeoutTask

timeoutTask