Module clientrequest :: Class ClientRequest
[hide private]
[frames] | no frames]

Class ClientRequest

source code


Instance Methods [hide private]
 
__init__(self, domainName, taskPath, *args, **kw)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
taskPath(self) source code
 
args(self) source code
 
setArgs(self, args) source code
 
setKw(self, kw) source code
 
kw(self) source code
 
setDomain(self, domain)
Sets the domain for this request
source code
 
domain(self)
Returns the domain for this request
source code
 
domainName(self)
Returns the domain name for this request
source code
 
setDomainName(self, domainName)
Sets the domain name
source code
 
setUser(self, user)
Sets the user object for this client request.
source code
 
setUserDict(self, userDict)
Sets the user object as an dict for this client request.
source code
 
user(self)
Returns the user object for this request.
source code
 
dumps(self)
Convert this instance to a (pickled) string.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]
 
loads(aStr)
Create a new instance from the passed pickled string.
source code
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, domainName, taskPath, *args, **kw)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

setDomain(self, domain)

source code 

Sets the domain for this request

Parameters:
  • domain - A Domain object

domain(self)

source code 

Returns the domain for this request

Returns:
The domain for this request

domainName(self)

source code 

Returns the domain name for this request

Returns:
The domain name for this request

setDomainName(self, domainName)

source code 

Sets the domain name

Parameters:
  • domainName (str) - Domain name for this request

setUserDict(self, userDict)

source code 

Sets the user object as an dict for this client request. Since user objects are unpickable, this method is used to pickle ClientRequest and send it to remote peers.

Parameters:
  • userDict - A dict, previously obtained from User.toDict()

user(self)

source code 

Returns the user object for this request. Automatically converts dict format to normal user object if this is the case.

Returns:
An MCUser instance

loads(aStr)
Static Method

source code 

Create a new instance from the passed pickled string.

Parameters:
  • aStr - A str, previously obtained from ClientRequest.dumps()