Package sqs :: Module objects :: Class SQSQueue
[hide private]
[frames] | no frames]

Class SQSQueue

source code


Instance Methods [hide private]
  __init__(self, url, sqs_conn)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  __str__(self)
str(x)
  __repr__(self)
repr(x)
SQSMessage read(self, timeout=None)
Returns a single message or None if queue is empty
SQSMessage write(self, message)
Add a single message to the queue
list get_messages(self, number, timeout=None)
Get a variable number of messages
  delete(self, message)
Delete the message from the queue

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__


Properties [hide private]

Inherited from object: __class__


Method Details [hide private]

__init__(self, url, sqs_conn)
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides: object.__init__
(inherited documentation)

__str__(self)
(Informal representation operator)

source code 
str(x)
Overrides: object.__str__
(inherited documentation)

__repr__(self)
(Representation operator)

source code 
repr(x)
Overrides: object.__repr__
(inherited documentation)

read(self, timeout=None)

source code 
Returns a single message or None if queue is empty
Parameters:
  • timeout (int) - Message visibility timeout
Returns: SQSMessage
One SQSMessage from the front of the Queue

write(self, message)

source code 
Add a single message to the queue
Parameters:
  • message (SQSMessage) - Message that should be added.
Returns: SQSMessage
SQSMessage with assigned Queue

get_messages(self, number, timeout=None)

source code 
Get a variable number of messages
Parameters:
  • number (int) - Number of messages to get
  • timeout (int) - Visibility timeout for the message
Returns: list
List of messages

delete(self, message)

source code 
Delete the message from the queue
Parameters:
  • message (SQSMessage) - Message to delete