Module cups :: Class IPPRequest
[hide private]
[frames] | no frames]

type IPPRequest

object --+
         |
        IPPRequest

IPP Request

An IPP request. The constructor takes an optional argument of the

operation code.

Instance Methods [hide private]
 
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
a new object with type S, a subtype of T
__new__(T, S, ...)
IPPAttribute
add(attr)
Returns: IPP request attribute
IPPAttribute
addSeparator()
Returns: IPP request attribute
IPP state
readIO(read_fn, blocking=True)
Returns: IPP state value
IPP state
writeIO(write_fn, blocking=True)
Returns: IPP state value
Properties [hide private]
  attributes
IPP request attributes
  operation
IPP request operation
  state
IPP request transfer state
  statuscode
IPP response status code
Method Details [hide private]

__init__(...)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

__new__(T, S, ...)

 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__

add(attr)

 
Parameters:
  • attr (IPPAttribute) - Attribute to add to the request
Returns: IPPAttribute
IPP request attribute

addSeparator()

 
Returns: IPPAttribute
IPP request attribute

readIO(read_fn, blocking=True)

 
Parameters:
  • read_fn (Callable function) - A callback, taking a single integer argument for 'size', for reading IPP data
  • blocking (Boolean) - whether to continue reading until a complete request is read
Returns: IPP state
IPP state value

writeIO(write_fn, blocking=True)

 
Parameters:
  • write_fn (Callable function) - A callback, taking a bytes object, for writing IPP data
  • blocking (Boolean) - whether to continue reading until a complete request is written
Returns: IPP state
IPP state value