dns_requestcontext_inc.cc 1.4 KB

123456789101112131415161718192021222324252627282930313233
  1. namespace {
  2. const char* const RequestContext_doc = "\
  3. DNS request to be checked.\n\
  4. \n\
  5. This plays the role of ACL context for the RequestACL object.\n\
  6. \n\
  7. Based on the minimalist philosophy, the initial implementation only\n\
  8. maintains the remote (source) IP address of the request and\n\
  9. (optionally) the TSIG record included in the request. We may add more\n\
  10. parameters of the request as we see the need for them. Possible\n\
  11. additional parameters are the local (destination) IP address, the\n\
  12. remote and local port numbers, various fields of the DNS request (e.g.\n\
  13. a particular header flag value).\n\
  14. \n\
  15. RequestContext(remote_address, tsig)\n\
  16. \n\
  17. In this initial implementation, the constructor only takes a\n\
  18. remote IP address in the form of a socket address as used in the\n\
  19. Python socket module, and optionally a pydnspp.TSIGRecord object.\n\
  20. \n\
  21. Exceptions:\n\
  22. isc.acl.ACLError Normally shouldn't happen, but still possible\n\
  23. for unexpected errors such as memory allocation\n\
  24. failure or an invalid address text being passed.\n\
  25. \n\
  26. Parameters:\n\
  27. remote_address The remote IP address\n\
  28. tsig The TSIG record included in the request message, if any.\n\
  29. If the request doesn't include a TSIG, this will be None.\n\
  30. If this parameter is omitted None will be assumed.\n\
  31. \n\
  32. ";
  33. } // unnamed namespace