<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2176/25/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/SIP+Data+Access+Layer+Objects">SIP Data Access Layer Objects</a></h2>
<h4>Page <b>edited</b> by <a href="https://wiki.asterisk.org/wiki/display/~jcolp">Joshua Colp</a>
</h4>
<br/>
<h4>Changes (1)</h4>
<div id="page-diffs">
<table class="diff" cellpadding="0" cellspacing="0">
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >| registrations | list | Outgoing registrations associated with endpoint | <br>| domain | string | Domain that the endpoint belongs to | <br></td></tr>
<tr><td class="diff-added-lines" style="background-color: #dfd;">| aor | string | Address of record to use for endpoint | <br></td></tr>
<tr><td class="diff-unchanged" > <br>h4. Registration <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
</table>
</div> <h4>Full Content</h4>
<div class="notificationGreySide">
<h2><a name="SIPDataAccessLayerObjects-General"></a>General</h2>
<p>The new SIP channel driver for Asterisk will have a clear separation of persistent data from the various modules and implementations therein. This will allow the persistent data to be stored using different methods such as: flat file, astdb, and other databases with no changes required elsewhere. A common API will be designed and implemented to allow this to happen. Before this occurs though the objects exposed by this data access layer need to be defined with minimal content and relationships. The objects listed will evolve and change with additional objects being added as development progresses. This page aims to propose an initial idea for the minimum required and to solicit feedback.</p>
<h4><a name="SIPDataAccessLayerObjects-Transport"></a>Transport</h4>
<p>The transport object contains information about configured SIP transports. These are what send and receive SIP traffic.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Variable Name </th>
<th class='confluenceTh'> Type </th>
<th class='confluenceTh'> Contents </th>
</tr>
<tr>
<td class='confluenceTd'> name </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Unique name for transport </td>
</tr>
<tr>
<td class='confluenceTd'> type </td>
<td class='confluenceTd'> enum </td>
<td class='confluenceTd'> Type of transport (UDP, TCP, TLS, WS, WSS) </td>
</tr>
<tr>
<td class='confluenceTd'> host </td>
<td class='confluenceTd'> ast_sockaddr </td>
<td class='confluenceTd'> IP address for transport to bind to (may be optional) </td>
</tr>
<tr>
<td class='confluenceTd'> port </td>
<td class='confluenceTd'> integer </td>
<td class='confluenceTd'> Port to bind to (may be optional) </td>
</tr>
</tbody></table>
</div>
<h5><a name="SIPDataAccessLayerObjects-TLSSpecific"></a>TLS Specific</h5>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Variable Name </th>
<th class='confluenceTh'> Type </th>
<th class='confluenceTh'> Contents </th>
</tr>
<tr>
<td class='confluenceTd'> authority </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Certificate authority filename or path </td>
</tr>
<tr>
<td class='confluenceTd'> certificate </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Path to certificate to use </td>
</tr>
<tr>
<td class='confluenceTd'> key </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Path to private key </td>
</tr>
<tr>
<td class='confluenceTd'> password </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Password for private key </td>
</tr>
<tr>
<td class='confluenceTd'> verifyserver </td>
<td class='confluenceTd'> bool </td>
<td class='confluenceTd'> Whether to require verification of server certificate or not </td>
</tr>
<tr>
<td class='confluenceTd'> verifyclient </td>
<td class='confluenceTd'> bool </td>
<td class='confluenceTd'> Whether to require verification of client certificate or not </td>
</tr>
<tr>
<td class='confluenceTd'> requireclient </td>
<td class='confluenceTd'> bool </td>
<td class='confluenceTd'> Whether to require a client certificate or not </td>
</tr>
</tbody></table>
</div>
<h4><a name="SIPDataAccessLayerObjects-Endpoint"></a>Endpoint</h4>
<p>The endpoint object contains information about a SIP trunk or SIP device.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Variable Name </th>
<th class='confluenceTh'> Type </th>
<th class='confluenceTh'> Contents </th>
</tr>
<tr>
<td class='confluenceTd'> name </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Unique name for endpoint </td>
</tr>
<tr>
<td class='confluenceTd'> codecs </td>
<td class='confluenceTd'> ast_format_cap </td>
<td class='confluenceTd'> Allowed formats </td>
</tr>
<tr>
<td class='confluenceTd'> dtmf </td>
<td class='confluenceTd'> enum </td>
<td class='confluenceTd'> DTMF method to use (inband, INFO, RFC2833) </td>
</tr>
<tr>
<td class='confluenceTd'> transport </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Name of transport to force endpoint to use </td>
</tr>
<tr>
<td class='confluenceTd'> cid_num </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Caller ID number </td>
</tr>
<tr>
<td class='confluenceTd'> cid_name </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Caller ID name </td>
</tr>
<tr>
<td class='confluenceTd'> cid_tag </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Caller ID tag </td>
</tr>
<tr>
<td class='confluenceTd'> context </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Context to place incoming calls into </td>
</tr>
<tr>
<td class='confluenceTd'> registrations </td>
<td class='confluenceTd'> list </td>
<td class='confluenceTd'> Outgoing registrations associated with endpoint </td>
</tr>
<tr>
<td class='confluenceTd'> domain </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Domain that the endpoint belongs to </td>
</tr>
<tr>
<td class='confluenceTd'> aor </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Address of record to use for endpoint </td>
</tr>
</tbody></table>
</div>
<h4><a name="SIPDataAccessLayerObjects-Registration"></a>Registration</h4>
<p>The registration object contains information about an outgoing registration.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Variable Name </th>
<th class='confluenceTh'> Type </th>
<th class='confluenceTh'> Contents </th>
</tr>
<tr>
<td class='confluenceTd'> host </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> IP address or host to register to </td>
</tr>
<tr>
<td class='confluenceTd'> port </td>
<td class='confluenceTd'> int </td>
<td class='confluenceTd'> Port to contact server on </td>
</tr>
<tr>
<td class='confluenceTd'> username </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Username to authenticate as </td>
</tr>
<tr>
<td class='confluenceTd'> password </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Password to use for authentication </td>
</tr>
</tbody></table>
</div>
<h4><a name="SIPDataAccessLayerObjects-Domain"></a>Domain</h4>
<p>The domain object holds information about a specific SIP domain.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Variable Name </th>
<th class='confluenceTh'> Type </th>
<th class='confluenceTh'> Contents </th>
</tr>
<tr>
<td class='confluenceTd'> name </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Unique name for domain </td>
</tr>
<tr>
<td class='confluenceTd'> context </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Context to place incoming calls into, if unauthenticated </td>
</tr>
</tbody></table>
</div>
<h4><a name="SIPDataAccessLayerObjects-AOR"></a>AOR</h4>
<p>The address of record object contains information used by a registrar for registrations.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Variable Name </th>
<th class='confluenceTh'> Type </th>
<th class='confluenceTh'> Contents </th>
</tr>
<tr>
<td class='confluenceTd'> name </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Unique name for AOR </td>
</tr>
<tr>
<td class='confluenceTd'> expiration </td>
<td class='confluenceTd'> int </td>
<td class='confluenceTd'> Default expiration if registration does not provide it </td>
</tr>
<tr>
<td class='confluenceTd'> contacts </td>
<td class='confluenceTd'> list </td>
<td class='confluenceTd'> List of contacts associated with this AOR </td>
</tr>
<tr>
<td class='confluenceTd'> domain </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Domain that the AOR belongs to </td>
</tr>
</tbody></table>
</div>
<h4><a name="SIPDataAccessLayerObjects-Contact"></a>Contact</h4>
<p>The contact object contains information about an inbound registration.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Variable Name </th>
<th class='confluenceTh'> Type </th>
<th class='confluenceTh'> Contents </th>
</tr>
<tr>
<td class='confluenceTd'> uri </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> Full URI to contact </td>
</tr>
<tr>
<td class='confluenceTd'> expiration </td>
<td class='confluenceTd'> timeval </td>
<td class='confluenceTd'> When this contact should expire </td>
</tr>
</tbody></table>
</div>
<h4><a name="SIPDataAccessLayerObjects-Notes"></a>Notes</h4>
<p>The above objects represent a minimum required to achieve basic functionality. They do not reflect all needed variables and objects and as previously stated will evolve and grow.</p>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/SIP+Data+Access+Layer+Objects">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/pages/diffpagesbyversion.action?pageId=21464622&revisedVersion=5&originalVersion=4">View Changes</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/SIP+Data+Access+Layer+Objects?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>