Class mailbox

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

Overrides: object.__init__

(inherited documentation)

Close the connection. It causes other threads that use the mailbox to raise an exception, unless you give it self._ignore as an argument. Npx and ngx specify how many threads will commit suicide; zero means none; setting either to 1 is a useful way to kill a single thread.

Legal values for for_put and for_get are any exception, anything returned from sys.exc_info, self.ignore and None.

• None => Do not raise an exception;
• self.ignore => Do not change whatever exception (or None) is already stored.

Put a value into the mailbox. If one of the close() functions has been used to set an exception on for_put, it will raise the exception instead.

Close the connection. This is normally called by the producer of data in place of put(). It can cause other threads to raise an exception.

This call acts like a put() in that it will block until the mailbox is emptied. It does not fill the mailbox, though. Following this call:

• get() will not block (it will raise an exception unless for_get is self.ignore or npx==0),
• put() will not block (it will raise an exception if for_put is not self.ignore and npx!=0),
• likewise putclose() and getclose().

It will raise an exception (unless defer_ex is True) if some other thread has closed first and set a for_put exception. However, it will set a for_get exception (if requested) before expiring.

Raise any residual exceptions. This is normally called by the producer of data

This call acts like a put() in that it will block until the mailbox is emptied or until an exception is waiting.

Get an item from the mailbox. Possibly, raise an exception if close or putclose has been called on the mailbox.

Close the connection. This is normally called by the consumer of data in place of get(). It causes other threads to raise an exception. It will raise an exception if some other thread has closed the mailbox first. Note that if there is something in the mailbox, it will empty and return the value.