t.m.m._MaildirNameGenerator : class documentation

Part of twisted.mail.maildir View Source View In Hierarchy

A utility class to generate a unique maildir name.

Instance Variable	n	A counter used to generate unique integers. (type: `int`)
Instance Variable	p	The ID of the current process. (type: `int`)
Instance Variable	s	A representation of the hostname. (type: `bytes`)
Method	__init__
Method	generate	Generate a string which is intended to be unique across all calls to this function (across all processes, reboots, etc).
Instance Variable	_clock	See `clock` parameter of `__init__`.

n =

A counter used to generate unique integers. (type: int)

p =

The ID of the current process. (type: int)

s =

A representation of the hostname. (type: bytes)

_clock =

See clock parameter of __init__.

def __init__(self, clock): (source)

Parameters clock A reactor which will be used to learn the current time. (type: IReactorTime provider)

def generate(self): (source)

Generate a string which is intended to be unique across all calls to this function (across all processes, reboots, etc).

Strings returned by earlier calls to this method will compare less than strings returned by later calls as long as the clock provided doesn't go backwards.

Returns A unique string. (type: bytes)

API Documentation for Twisted, generated by pydoctor at 2014-09-17 19:15:55.