| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Developer’s Guide — Traffic Control 1.1.4 documentation </title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../_static/favicon.ico"/> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" /> |
| |
| |
| |
| <link rel="top" title="Traffic Control 1.1.4 documentation" href="../index.html"/> |
| <link rel="next" title="Traffic Ops" href="traffic_ops.html"/> |
| <link rel="prev" title="Configure Multi Site Origin" href="../admin/quick_howto/multi_site.html"/> |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-nav-search"> |
| |
| |
| |
| <a href="/" class="icon icon-home"> Traffic Control |
| |
| |
| |
| |
| <img src="../_static/tc_logo.png" class="logo" /> |
| |
| </a> |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../basics/index.html">CDN Basics</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../basics/content_delivery_networks.html">Content Delivery Networks</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../basics/http_11.html">HTTP 1.1</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../basics/caching_proxies.html">Caching Proxies</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Traffic Control Overview</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../overview/introduction.html">Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../overview/traffic_ops.html">Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../overview/traffic_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops_using.html">Using Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_server.html">Traffic Server Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_vault.html">Traffic Vault Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/quick_howto/index.html">Quick How To Guides</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="current reference internal" href="">Developer’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">FAQ</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../faq/general.html">General</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../faq/development.html">Development</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../faq/administration.html">Running a Traffic Control CDN</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../index.html">Traffic Control</a> |
| </nav> |
| |
| |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../index.html">Traffic Control 1.1.4</a> »</li> |
| |
| <li>Developer’s Guide</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="../_sources/development/index.txt" rel="nofollow"> View page source</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="traffic_ops.html" class="btn btn-neutral float-right" title="Traffic Ops">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../admin/quick_howto/multi_site.html" class="btn btn-neutral" title="Configure Multi Site Origin"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <div class="section" id="developer-s-guide"> |
| <h1>Developer’s Guide<a class="headerlink" href="#developer-s-guide" title="Permalink to this headline">¶</a></h1> |
| <p>Use this guide to start developing applications that consume the Traffic Control APIs, to create extensions to Traffic Ops, or work on Traffic Control itself.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#introduction">Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#software-requirements">Software Requirements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#traffic-ops-project-tree-overview">Traffic Ops Project Tree Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#perl-formatting-conventions">Perl Formatting Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#database-management">Database Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#installing-the-developer-environment">Installing The Developer Environment</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#test-cases">Test Cases</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#extensions">Extensions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#api">API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="traffic_router.html">Traffic Router</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_router.html#introduction">Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_router.html#software-requirements">Software Requirements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_router.html#traffic-router-project-tree-overview">Traffic Router Project Tree Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_router.html#java-formatting-conventions">Java Formatting Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_router.html#installing-the-developer-environment">Installing The Developer Environment</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_router.html#test-cases">Test Cases</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_router.html#api">API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#introduction">Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#software-requirements">Software Requirements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#traffic-monitor-project-tree-overview">Traffic Monitor Project Tree Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#java-formatting-conventions">Java Formatting Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#installing-the-developer-environment">Installing The Developer Environment</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#test-cases">Test Cases</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#api">API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#introduction">Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#software-requirements">Software Requirements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#traffic-stats-project-tree-overview">Traffic Stats Project Tree Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#go-formatting-conventions">Go Formatting Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#installing-the-developer-environment">Installing The Developer Environment</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#test-cases">Test Cases</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="traffic_ops.html" class="btn btn-neutral float-right" title="Traffic Ops">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../admin/quick_howto/multi_site.html" class="btn btn-neutral" title="Configure Multi Site Origin"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../', |
| VERSION:'1.1.4', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true |
| }; |
| </script> |
| <script type="text/javascript" src="../_static/jquery.js"></script> |
| <script type="text/javascript" src="../_static/underscore.js"></script> |
| <script type="text/javascript" src="../_static/doctools.js"></script> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |
