| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.5"/> |
| <title>Apache Mesos: process::http::authentication::AuthenticationResult Struct Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Mesos |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.5 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li><a href="examples.html"><span>Examples</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceprocess.html">process</a></li><li class="navelem"><a class="el" href="namespaceprocess_1_1http.html">http</a></li><li class="navelem"><a class="el" href="namespaceprocess_1_1http_1_1authentication.html">authentication</a></li><li class="navelem"><a class="el" href="structprocess_1_1http_1_1authentication_1_1AuthenticationResult.html">AuthenticationResult</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structprocess_1_1http_1_1authentication_1_1AuthenticationResult-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">process::http::authentication::AuthenticationResult Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Represents the result of authenticating a request. |
| <a href="structprocess_1_1http_1_1authentication_1_1AuthenticationResult.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="3rdparty_2libprocess_2include_2process_2authenticator_8hpp_source.html">authenticator.hpp</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a999ea72bc42ca09641699398e612540a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOption.html">Option</a>< <a class="el" href="structprocess_1_1http_1_1authentication_1_1Principal.html">Principal</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structprocess_1_1http_1_1authentication_1_1AuthenticationResult.html#a999ea72bc42ca09641699398e612540a">principal</a></td></tr> |
| <tr class="separator:a999ea72bc42ca09641699398e612540a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a88c899e54bb134e3af1f1a5ff436f72b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOption.html">Option</a>< <a class="el" href="structprocess_1_1http_1_1Unauthorized.html">Unauthorized</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structprocess_1_1http_1_1authentication_1_1AuthenticationResult.html#a88c899e54bb134e3af1f1a5ff436f72b">unauthorized</a></td></tr> |
| <tr class="separator:a88c899e54bb134e3af1f1a5ff436f72b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f7bf328559256080f71f66620100aab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOption.html">Option</a>< <a class="el" href="structprocess_1_1http_1_1Forbidden.html">Forbidden</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structprocess_1_1http_1_1authentication_1_1AuthenticationResult.html#a0f7bf328559256080f71f66620100aab">forbidden</a></td></tr> |
| <tr class="separator:a0f7bf328559256080f71f66620100aab"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Represents the result of authenticating a request. </p> |
| <p>An <code><a class="el" href="structprocess_1_1http_1_1authentication_1_1AuthenticationResult.html" title="Represents the result of authenticating a request. ">AuthenticationResult</a></code> can represent one of the following states:</p> |
| <ol type="1"> |
| <li>The request was successfully authenticated: <code>principal</code> is set.</li> |
| <li>The request was not authenticated and a new challenge is issued: <code>unauthorized</code> is set.</li> |
| <li>The request was not authenticated but no new challenge is issued: <code>forbidden</code> is set.</li> |
| </ol> |
| <p>Exactly one of the member variables must be set. Setting more than one or not setting any is an error. </p> |
| </div><h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="a0f7bf328559256080f71f66620100aab"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classOption.html">Option</a><<a class="el" href="structprocess_1_1http_1_1Forbidden.html">Forbidden</a>> process::http::authentication::AuthenticationResult::forbidden</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a999ea72bc42ca09641699398e612540a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classOption.html">Option</a><<a class="el" href="structprocess_1_1http_1_1authentication_1_1Principal.html">Principal</a>> process::http::authentication::AuthenticationResult::principal</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a88c899e54bb134e3af1f1a5ff436f72b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classOption.html">Option</a><<a class="el" href="structprocess_1_1http_1_1Unauthorized.html">Unauthorized</a>> process::http::authentication::AuthenticationResult::unauthorized</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>3rdparty/libprocess/include/process/<a class="el" href="3rdparty_2libprocess_2include_2process_2authenticator_8hpp_source.html">authenticator.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |