# pyzor.message

This modules contains the various messages used in the pyzor client server communication.

class pyzor.message.CheckRequest(digest=None)

  Bases: `SimpleDigestBasedRequest`

  op = 'check'

class pyzor.message.ClientSideRequest

  Bases: `Request`

  op = None
  setup()

class pyzor.message.InfoRequest(digest=None)

  Bases: `SimpleDigestBasedRequest`

  op = 'info'

class pyzor.message.Message

  Bases: `Message`

  ensure_complete()
  init_for_sending()
  setup()

class pyzor.message.PingRequest

  Bases: `ClientSideRequest`

  op = 'ping'

class pyzor.message.PongRequest(digest=None)

  Bases: `SimpleDigestBasedRequest`

  op = 'pong'

class pyzor.message.ReportRequest(digest=None, spec=None)

  Bases: `SimpleDigestSpecBasedRequest`

  op = 'report'

class pyzor.message.Request

  Bases: `ThreadedMessage`

  This is the class that should be used to read in Requests of any type. Subclasses are responsible for setting ‘Op’ if they are generating a message,

  ensure_complete()
  get_op()

class pyzor.message.Response

  Bases: `ThreadedMessage`

  ensure_complete()
  get_code()
  get_diag()
  head_tuple()
  is_ok()
  ok_code = 200

class pyzor.message.SimpleDigestBasedRequest(digest=None)

  Bases: `ClientSideRequest`

  add_digest(digest)

class pyzor.message.SimpleDigestSpecBasedRequest(digest=None, spec=None)

  Bases: `SimpleDigestBasedRequest`

class pyzor.message.ThreadId(i)

  Bases: `int`

  error_value = 0
  full_range = (0, 65536)
  classmethod generate()
  in_ok_range()
  ok_range = (1024, 65536)

class pyzor.message.ThreadedMessage

  Bases: `Message`

  ensure_complete()
  get_protocol_version()
  get_thread()
  init_for_sending()
  set_thread(i)

class pyzor.message.WhitelistRequest(digest=None, spec=None)

  Bases: `SimpleDigestSpecBasedRequest`

  op = 'whitelist'