Skip to content
Browse files

change to 0.4.0-SNAPSHOT

  • Loading branch information...
1 parent 856a15e commit 65d6fb8b03c4b4e73abb69bcde14ec5044a8106c @Ruiyun committed
View
77 api-index.html
@@ -35,7 +35,7 @@
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
- <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.util-api.html" class="wiki_link">cljain.util</a></li>
+ <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.tools.predicate-api.html" class="wiki_link">cljain.tools.predicate</a></li><li><a href="cljain.tools.timer-api.html" class="wiki_link">cljain.tools.timer</a></li>
</ul>
</div>
@@ -81,18 +81,17 @@ <h2 id="A"><span id="section-head">A</span></h2>
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/accept-encoding">accept-encoding</a><span id="line-content"> function cljain.sip.header Create a new AcceptEncodingHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/accept-language">accept-language</a><span id="line-content"> function cljain.sip.header Create a new AcceptLanguageHeader.
</span></span><span id="section-content"> <a href="cljain.dum-api.html#cljain.dum/account">account</a><span id="line-content"> function cljain.dum Get current bound account information..
-</span></span><span id="section-content"> <a href="cljain.dum-api.html#cljain.dum/account-map">account-map</a><span id="line-content"> var cljain.dum Store current account information, contain :user :...
-</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/ack">ack</a><span id="line-content"> function cljain.sip.dialog Creates an ACK request for an Invite that was resp...
+</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/ack">ack</a><span id="line-content"> function cljain.sip.dialog DEPRECATED: Use Java method 'createAck' directly i...
</span></span><span id="section-content"> <a href="cljain.dum-api.html#cljain.dum/add-handler!">add-handler!</a><span id="line-content"> function cljain.dum Add a sip request received event handler to dum..
-</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/add-header!">add-header!</a><span id="line-content"> function cljain.sip.message The Header is added to the end of the List and wil...
+</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/add-header!">add-header!</a><span id="line-content"> function cljain.sip.message DEPRECATED: Use Java method 'addHeader' directly i...
</span></span><span id="section-content"> <a href="cljain.sip.address-api.html#cljain.sip.address/address">address</a><span id="line-content"> function cljain.sip.address Create a new Address object using a URI. It useful...
</span></span><span id="section-content"> <a href="cljain.sip.address-api.html#cljain.sip.address/address?">address?</a><span id="line-content"> function cljain.sip.address Check the 'obj' is an instance of javax.sip.Addres...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/alert-info">alert-info</a><span id="line-content"> function cljain.sip.header Create a new AlertInfoHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/allow">allow</a><span id="line-content"> function cljain.sip.header Create a new AllowHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/allow-events">allow-events</a><span id="line-content"> function cljain.sip.header Create a new AllowEventsHeader.
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/already-bound-provider?">already-bound-provider?</a><span id="line-content"> function cljain.sip.core Check whether the *sip-provider* has been bound in...
-</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/application-data">application-data</a><span id="line-content"> function cljain.sip.dialog Gets the application specific data specific to thi...
-</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/application-data">application-data</a><span id="line-content"> function cljain.sip.transaction Returns the application data associated with t...
+</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/application-data">application-data</a><span id="line-content"> function cljain.sip.dialog DEPRECATED: Use Java method 'getApplicationData' d...
+</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/application-data">application-data</a><span id="line-content"> function cljain.sip.transaction DEPRECATED: Use Java method 'getApplicationDat...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/authentication-info">authentication-info</a><span id="line-content"> function cljain.sip.header Create a new AuthenticationInfoHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/authorization">authorization</a><span id="line-content"> function cljain.sip.header Create a new AuthorizationHeader.
</span></span>
@@ -100,7 +99,7 @@ <h2 id="A"><span id="section-head">A</span></h2>
</div><div id="index-body">
<h2 id="B"><span id="section-head">B</span></h2>
<pre>
-<span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/branch-id">branch-id</a><span id="line-content"> function cljain.sip.transaction Returns a unique branch identifer that identif...
+<span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/branch-id">branch-id</a><span id="line-content"> function cljain.sip.transaction DEPRECATED: Use Java method 'getBranchId' dire...
</span></span>
</pre>
</div><div id="index-body">
@@ -109,24 +108,28 @@ <h2 id="C"><span id="section-head">C</span></h2>
<span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/c-seq">c-seq</a><span id="line-content"> function cljain.sip.header Create a new CSeqHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/call-id">call-id</a><span id="line-content"> function cljain.sip.header Create a new CallIdHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/call-info">call-info</a><span id="line-content"> function cljain.sip.header Create a new CallInfoHeader.
-</span></span><span id="section-content"> <a href="cljain.util-api.html#cljain.util/check-optional">check-optional</a><span id="line-content"> macro cljain.util place doc string here.
-</span></span><span id="section-content"> <a href="cljain.util-api.html#cljain.util/check-required">check-required</a><span id="line-content"> macro cljain.util place doc string here.
+</span></span><span id="section-content"> <a href="cljain.tools.timer-api.html#cljain.tools.timer/cancel!">cancel!</a><span id="line-content"> function cljain.tools.timer Terminates a timer, discarding any currently sched...
+</span></span><span id="section-content"> <a href="cljain.tools.predicate-api.html#cljain.tools.predicate/check-optional">check-optional</a><span id="line-content"> macro cljain.tools.predicate place doc string here.
+</span></span><span id="section-content"> <a href="cljain.tools.predicate-api.html#cljain.tools.predicate/check-required">check-required</a><span id="line-content"> macro cljain.tools.predicate place doc string here.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/contact">contact</a><span id="line-content"> function cljain.sip.header Create a new ContactHeader.
+</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/content">content</a><span id="line-content"> function cljain.sip.message DEPRECATED: Use Java method 'getContent' directly ...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/content-disposition">content-disposition</a><span id="line-content"> function cljain.sip.header Create a new ContentDispositionHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/content-encoding">content-encoding</a><span id="line-content"> function cljain.sip.header Create a new ContentEncodingHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/content-language">content-language</a><span id="line-content"> function cljain.sip.header Create a new ContentLanguageHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/content-length">content-length</a><span id="line-content"> function cljain.sip.header Create a new ContentLengthHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/content-type">content-type</a><span id="line-content"> function cljain.sip.header Create a new ContentTypeHeader.
-</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/create-request">create-request</a><span id="line-content"> function cljain.sip.dialog Creates a new Request message based on the dialog ...
+</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/create-request">create-request</a><span id="line-content"> function cljain.sip.dialog DEPRECATED: Use Java method 'createRequest' direct...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="D"><span id="section-head">D</span></h2>
<pre>
<span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/date">date</a><span id="line-content"> function cljain.sip.header Create a new DateHeader.
+</span></span><span id="section-content"> <a href="cljain.tools.timer-api.html#cljain.tools.timer/deamon-timer">deamon-timer</a><span id="line-content"> function cljain.tools.timer Create a new java.util.Timer object with deamon op...
</span></span><span id="section-content"> <a href="cljain.dum-api.html#cljain.dum/def-request-handler">def-request-handler</a><span id="line-content"> macro cljain.dum Define the handler to handle the sip request recei...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/defheader">defheader</a><span id="line-content"> macro cljain.sip.header Use the macro to define sip headers. More document...
-</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/dialog?">dialog?</a><span id="line-content"> function cljain.sip.dialog Check the obj is an instance of javax.sip.Dialog.
+</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/dialog?">dialog?</a><span id="line-content"> function cljain.sip.core Check the obj is an instance of javax.sip.Dialog.
+</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/dialog?">dialog?</a><span id="line-content"> function cljain.sip.dialog DEPRECATED: Use 'cljain.core/dialog?' instead. Che...
</span></span>
</pre>
</div><div id="index-body">
@@ -151,7 +154,7 @@ <h2 id="G"><span id="section-head">G</span></h2>
<span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/gen-branch">gen-branch</a><span id="line-content"> function cljain.sip.header Generate a new branch id string..
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/gen-call-id-header">gen-call-id-header</a><span id="line-content"> function cljain.sip.core Generate a new Call-ID header use current bound pr...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/gen-tag">gen-tag</a><span id="line-content"> function cljain.sip.header Generate a new tag string..
-</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/get-address">get-address</a><span id="line-content"> function cljain.sip.header place doc string here.
+</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/get-address">get-address</a><span id="line-content"> function cljain.sip.header DEPRECATED: Use Java method 'getAddress' directly ...
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/global-bind-sip-provider!">global-bind-sip-provider!</a><span id="line-content"> function cljain.sip.core Bind the sip-provider in global scope..
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/global-unbind-sip-provider!">global-unbind-sip-provider!</a><span id="line-content"> function cljain.sip.core Unbind the sip-provider in global scope..
</span></span>
@@ -159,7 +162,7 @@ <h2 id="G"><span id="section-head">G</span></h2>
</div><div id="index-body">
<h2 id="H"><span id="section-head">H</span></h2>
<pre>
-<span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/header">header</a><span id="line-content"> function cljain.sip.message Gets the Header of the specified name in this Mess...
+<span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/header">header</a><span id="line-content"> function cljain.sip.message DEPRECATED: Use Java method 'getHeader' directly i...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/header?">header?</a><span id="line-content"> function cljain.sip.header Check whether the object is a Header or not.
</span></span>
</pre>
@@ -167,7 +170,8 @@ <h2 id="H"><span id="section-head">H</span></h2>
<h2 id="I"><span id="section-head">I</span></h2>
<pre>
<span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/in-reply-to">in-reply-to</a><span id="line-content"> function cljain.sip.header Create a new InReplyToHeader.
-</span></span><span id="section-content"> <a href="cljain.util-api.html#cljain.util/in?">in?</a><span id="line-content"> function cljain.util Chekc whether v is in the coll or not..
+</span></span><span id="section-content"> <a href="cljain.tools.predicate-api.html#cljain.tools.predicate/in?">in?</a><span id="line-content"> function cljain.tools.predicate Chekc whether v is in the coll or not..
+</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/inc-sequence-number!">inc-sequence-number!</a><span id="line-content"> function cljain.sip.message Increase the sequence number of a request's CSeq h...
</span></span><span id="section-content"> <a href="cljain.dum-api.html#cljain.dum/initialize!">initialize!</a><span id="line-content"> function cljain.dum Set the default user account information with the ...
</span></span>
</pre>
@@ -185,7 +189,7 @@ <h2 id="K"><span id="section-head">K</span></h2>
<h2 id="L"><span id="section-head">L</span></h2>
<pre>
<span id="section-content"> <a href="cljain.dum-api.html#cljain.dum/legal-content?">legal-content?</a><span id="line-content"> function cljain.dum Check the content is a string or a map with :type,...
-</span></span><span id="section-content"> <a href="cljain.util-api.html#cljain.util/legal-option?">legal-option?</a><span id="line-content"> macro cljain.util place doc string here.
+</span></span><span id="section-content"> <a href="cljain.tools.predicate-api.html#cljain.tools.predicate/legal-option?">legal-option?</a><span id="line-content"> macro cljain.tools.predicate place doc string here.
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/listening-point">listening-point</a><span id="line-content"> function cljain.sip.core Get the current bound listening ip, port and trans...
</span></span>
</pre>
@@ -193,7 +197,7 @@ <h2 id="L"><span id="section-head">L</span></h2>
<h2 id="M"><span id="section-head">M</span></h2>
<pre>
<span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/max-forwards">max-forwards</a><span id="line-content"> function cljain.sip.header Create a new MaxForwardsHeader.
-</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/method">method</a><span id="line-content"> function cljain.sip.message Gets method string of this Request message..
+</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/method">method</a><span id="line-content"> function cljain.sip.message DEPRECATED: Use Java method 'getMethod' directly i...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/mime-version">mime-version</a><span id="line-content"> function cljain.sip.header Create a new MimeVersionHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/min-expires">min-expires</a><span id="line-content"> function cljain.sip.header Create a new MinExpiresHeader.
</span></span>
@@ -232,14 +236,17 @@ <h2 id="R"><span id="section-head">R</span></h2>
<pre>
<span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/r-ack">r-ack</a><span id="line-content"> function cljain.sip.header Create a new RAckHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/r-seq">r-seq</a><span id="line-content"> function cljain.sip.header Create a new RSeqHeader.
+</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/raw-content">raw-content</a><span id="line-content"> function cljain.sip.message DEPRECATED: Use Java method 'getRawContent' direct...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/reason">reason</a><span id="line-content"> function cljain.sip.header Create a new ReasonHeader.
</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/reason">reason</a><span id="line-content"> function cljain.sip.message Gets the reason phrase of this Response message..
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/record-route">record-route</a><span id="line-content"> function cljain.sip.header Create a new RecordRouteHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/refer-to">refer-to</a><span id="line-content"> function cljain.sip.header Create a new ReferToHeader.
-</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/remove-header!">remove-header!</a><span id="line-content"> function cljain.sip.message Removes the Header of the supplied name from the l...
+</span></span><span id="section-content"> <a href="cljain.dum-api.html#cljain.dum/register-to">register-to</a><span id="line-content"> function cljain.dum Send REGISTER sip message to target registry serve...
+</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/remove-content!">remove-content!</a><span id="line-content"> function cljain.sip.message DEPRECATED: Use Java method 'removeContent' direct...
+</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/remove-header!">remove-header!</a><span id="line-content"> function cljain.sip.message DEPRECATED: Use Java method 'removeHeader' directl...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/reply-to">reply-to</a><span id="line-content"> function cljain.sip.header Create a new ReplyToHeader.
</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/request">request</a><span id="line-content"> function cljain.sip.message Creates a new Request message of type specified by...
-</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/request">request</a><span id="line-content"> function cljain.sip.transaction Returns the request that created this transact...
+</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/request">request</a><span id="line-content"> function cljain.sip.transaction DEPRECATED: Use Java method 'getRequest' direc...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/require">require</a><span id="line-content"> function cljain.sip.header Create a new RequireHeader.
</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/response">response</a><span id="line-content"> function cljain.sip.message Creates a new Response message of type specified b...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/retry-after">retry-after</a><span id="line-content"> function cljain.sip.header Create a new RetryAfterHeader.
@@ -250,29 +257,31 @@ <h2 id="R"><span id="section-head">R</span></h2>
<h2 id="S"><span id="section-head">S</span></h2>
<pre>
<span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/*sip-provider*">*sip-provider*</a><span id="line-content"> var cljain.sip.core Before call any function expect 'sip-provider!' in...
-</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/send-ack!">send-ack!</a><span id="line-content"> function cljain.sip.dialog Sends ACK Request to the remote party of this dial...
+</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/send-ack!">send-ack!</a><span id="line-content"> function cljain.sip.dialog DEPRECATED: Use Java method 'sendAck' directly ins...
</span></span><span id="section-content"> <a href="cljain.dum-api.html#cljain.dum/send-request!">send-request!</a><span id="line-content"> function cljain.dum Fluent style sip message send function. The simpl...
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/send-request!">send-request!</a><span id="line-content"> function cljain.sip.core Send out of dialog SipRequest use current bound pr...
-</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/send-request!">send-request!</a><span id="line-content"> function cljain.sip.dialog Sends a Request to the remote party of this dialog...
-</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/send-request!">send-request!</a><span id="line-content"> function cljain.sip.transaction Sends the Request which created this ClientTra...
+</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/send-request!">send-request!</a><span id="line-content"> function cljain.sip.dialog DEPRECATED: Use Java method 'sendRequest' directly...
+</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/send-request!">send-request!</a><span id="line-content"> function cljain.sip.transaction DEPRECATED: Use Java method 'sendRequest' dire...
</span></span><span id="section-content"> <a href="cljain.dum-api.html#cljain.dum/send-response!">send-response!</a><span id="line-content"> function cljain.dum Send response with a server transactions..
-</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/send-response!">send-response!</a><span id="line-content"> function cljain.sip.transaction Sends the Response to a Request which is assoc...
+</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/send-response!">send-response!</a><span id="line-content"> function cljain.sip.transaction DEPRECATED: Use Java method 'sendResponse' dir...
+</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/sequence-number">sequence-number</a><span id="line-content"> function cljain.sip.header DEPRECATED: Use Java method 'getSequenceNumber' di...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/server">server</a><span id="line-content"> function cljain.sip.header Create a new ServerHeader.
-</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/set-application-data">set-application-data</a><span id="line-content"> function cljain.sip.dialog Sets application specific data to this dialog..
-</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/set-application-data!">set-application-data!</a><span id="line-content"> function cljain.sip.transaction This method allows applications to associate a...
-</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/set-content!">set-content!</a><span id="line-content"> function cljain.sip.message Sets the new Header to replace existings Header of...
-</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/set-header!">set-header!</a><span id="line-content"> function cljain.sip.message Sets the new Header to replace existings Header of...
+</span></span><span id="section-content"> <a href="cljain.sip.dialog-api.html#cljain.sip.dialog/set-application-data">set-application-data</a><span id="line-content"> function cljain.sip.dialog DEPRECATED: Use Java method 'setApplicationData' d...
+</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/set-application-data!">set-application-data!</a><span id="line-content"> function cljain.sip.transaction DEPRECATED: Use Java method 'setApplicationDat...
+</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/set-content!">set-content!</a><span id="line-content"> function cljain.sip.message DEPRECATED: Use Java method 'setContent' directly ...
+</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/set-header!">set-header!</a><span id="line-content"> function cljain.sip.message DEPRECATED: Use Java method 'setHeader' directly i...
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/set-listener!">set-listener!</a><span id="line-content"> function cljain.sip.core Set several event listening function to current bo...
+</span></span><span id="section-content"> <a href="cljain.sip.address-api.html#cljain.sip.address/sip-address">sip-address</a><span id="line-content"> function cljain.sip.address A convenient way to create a new Address object th...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/sip-etag">sip-etag</a><span id="line-content"> function cljain.sip.header Creates a new SIP-ETag header with the supplied ta...
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/sip-factory">sip-factory</a><span id="line-content"> var cljain.sip.core The instance of JAIN-SIP SipFactory..
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/sip-if-match">sip-if-match</a><span id="line-content"> function cljain.sip.header Creates a new SIP-If-Match header with the supplie...
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/sip-provider">sip-provider</a><span id="line-content"> function cljain.sip.core Get the current bound *sip-provider* or global-sip...
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/sip-provider!">sip-provider!</a><span id="line-content"> function cljain.sip.core Create a new SipProvider with meaningful name, loc...
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/sip-stack">sip-stack</a><span id="line-content"> function cljain.sip.core Get the SipStack object from a SipProvider object..
-</span></span><span id="section-content"> <a href="cljain.sip.address-api.html#cljain.sip.address/sip-uri">sip-uri</a><span id="line-content"> function cljain.sip.address Create a new SipURI object. It is useful to create...
+</span></span><span id="section-content"> <a href="cljain.sip.address-api.html#cljain.sip.address/sip-uri">sip-uri</a><span id="line-content"> function cljain.sip.address Create a new SipURI object. (sip-uri "localhost" ...
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/stack-name">stack-name</a><span id="line-content"> function cljain.sip.core Get the SipStack name from a SipProvider object..
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/start!">start!</a><span id="line-content"> function cljain.sip.core Start to run the stack which bound with current bo...
-</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/status-code">status-code</a><span id="line-content"> function cljain.sip.message Gets the integer value of the status code of Respo...
+</span></span><span id="section-content"> <a href="cljain.sip.message-api.html#cljain.sip.message/status-code">status-code</a><span id="line-content"> function cljain.sip.message DEPRECATED: Use Java method 'getStatusCode' direct...
</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/stop-and-release!">stop-and-release!</a><span id="line-content"> function cljain.sip.core Stop the stack wich bound with current bound provi...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/subject">subject</a><span id="line-content"> function cljain.sip.header Create a new SubjectHeader.
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/subscription-state">subscription-state</a><span id="line-content"> function cljain.sip.header Create a new SubscriptionStateHeader.
@@ -282,17 +291,21 @@ <h2 id="S"><span id="section-head">S</span></h2>
</div><div id="index-body">
<h2 id="T"><span id="section-head">T</span></h2>
<pre>
-<span id="section-content"> <a href="cljain.sip.address-api.html#cljain.sip.address/tel-uri">tel-uri</a><span id="line-content"> function cljain.sip.address Create a new TelURI object with a phone number. (...
+<span id="section-content"> <a href="cljain.tools.timer-api.html#cljain.tools.timer/task">task</a><span id="line-content"> macro cljain.tools.timer Create a java.util.TimerTask object with some code...
+</span></span><span id="section-content"> <a href="cljain.sip.address-api.html#cljain.sip.address/tel-uri">tel-uri</a><span id="line-content"> function cljain.sip.address Create a new TelURI object with a phone number. (...
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/time-stamp">time-stamp</a><span id="line-content"> function cljain.sip.header Create a new TimeStampHeader.
+</span></span><span id="section-content"> <a href="cljain.tools.timer-api.html#cljain.tools.timer/timer">timer</a><span id="line-content"> function cljain.tools.timer Create a new java.util.Timer object..
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/to">to</a><span id="line-content"> function cljain.sip.header Create a new ToHeader.
-</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/transaction?">transaction?</a><span id="line-content"> function cljain.sip.transaction Check the obj is an instance of javax.sip.Tran...
+</span></span><span id="section-content"> <a href="cljain.sip.core-api.html#cljain.sip.core/transaction?">transaction?</a><span id="line-content"> function cljain.sip.core Check the obj is an instance of javax.sip.Transact...
+</span></span><span id="section-content"> <a href="cljain.sip.transaction-api.html#cljain.sip.transaction/transaction?">transaction?</a><span id="line-content"> function cljain.sip.transaction DEPRECATED: Use 'cljain.core/transaction?' ins...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="U"><span id="section-head">U</span></h2>
<pre>
-<span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/unsupported">unsupported</a><span id="line-content"> function cljain.sip.header Create a new UnsupportedHeader.
-</span></span><span id="section-content"> <a href="cljain.sip.address-api.html#cljain.sip.address/uri-from-address">uri-from-address</a><span id="line-content"> function cljain.sip.address Get the URI member from a Address object..
+<span id="section-content"> <a href="cljain.dum-api.html#cljain.dum/unregister-to">unregister-to</a><span id="line-content"> function cljain.dum Send REGISTER sip message with expires 0 for unreg...
+</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/unsupported">unsupported</a><span id="line-content"> function cljain.sip.header Create a new UnsupportedHeader.
+</span></span><span id="section-content"> <a href="cljain.sip.address-api.html#cljain.sip.address/uri-from-address">uri-from-address</a><span id="line-content"> function cljain.sip.address DEPRECATED: Use Java method 'getURI' directly inst...
</span></span><span id="section-content"> <a href="cljain.sip.address-api.html#cljain.sip.address/uri?">uri?</a><span id="line-content"> function cljain.sip.address Check the 'obj' is an instance of javax.sip.URI..
</span></span><span id="section-content"> <a href="cljain.sip.header-api.html#cljain.sip.header/user-agent">user-agent</a><span id="line-content"> function cljain.sip.header Create a new UserAgentHeader.
</span></span>
View
240 cljain.core-api.html
@@ -0,0 +1,240 @@
+<html>
+ <head>
+ <title>cljain.core - cljain API documentation</title>
+ <link href="static/favicon.png" rel="icon" />
+ <link href="static/favicon.png" rel="shortcut icon" />
+ <link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
+ <link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
+ <link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
+ <style>.menuWrapper{height: 36px;}</style>
+ <!--[if lte IE 6]>
+ <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
+ <![endif]-->
+ </head>
+<!--
+This document was auto-generated from the source by the clojure autodoc system.
+To report errors or ask questions about the overall documentation structure, formatting,
+etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
+For errors in the documentation of a particular namespace, contact the author of that
+namespace.
+-->
+ <body>
+ <div id="AllContentContainer">
+ <div id="Header">
+ <a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
+ <h1><a title="page header title" id="page-header" href="index.html">cljain API Documentation</a></h1>
+ </div>
+ <div id="leftcolumn"><div style="text-align: center;"></div>
+<div class="menu">
+ <div class="WikiCustomNav WikiElement wiki">
+ <span class="toc-header"><span id="project-name">cljain</span> <span id="version"></span> API</span><br />
+ <ul>
+ <li><a class="wiki_link" href="index.html">Overview</a></li>
+ <li><a class="wiki_link" href="api-index.html">API Index</a></li>
+ </ul>
+ <div class="NamespaceTOC">
+ <span class="toc-header">Namespaces</span>
+ <ul id="left-sidebar-list">
+ <li><a href="cljain.core-api.html" class="wiki_link">cljain.core</a></li><li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.tools.predicate-api.html" class="wiki_link">cljain.tools.predicate</a></li><li><a href="cljain.tools.timer-api.html" class="wiki_link">cljain.tools.timer</a></li>
+ </ul>
+ </div>
+
+ <a href="http://clojure.org" class="wiki_link">Clojure Home</a>
+ </div>
+</div>
+</div>
+ <div id="rightcolumn">
+ <div id="Content">
+ <div class="contentBox"><div class="innerContentBox">
+ <div id="content_view" class="wiki wikiPage">
+ <div id="right-sidebar"><div id="toc">
+ <h1 class="nopad">Table of Contents</h1>
+ <div style="margin-left: 1em;" class="toc-section">
+ <a href="#toc0">Overview</a>
+ <div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/address">address</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/address?">address?</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/dialog?">dialog?</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/header?">header?</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/inc-sequence-number!">inc-sequence-number!</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/reason">reason</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/sip-address">sip-address</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/sip-uri">sip-uri</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/tel-uri">tel-uri</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/transaction?">transaction?</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.core/uri?">uri?</a>
+ </div>
+ <br />
+ </div>
+</div>
+</div>
+ <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">cljain.core</span>
+ - <span id="header-project">cljain</span> <span id="header-version"></span>
+ </h1>
+
+<br />Full namespace name: <span id="long-name">cljain.core</span>
+<p></p>
+<h2>Overview</h2>
+<pre id="namespace-docstr"></pre>
+
+
+<br />
+<h2>Public Variables and Functions</h2>
+<div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/address">address</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (address uri)
+ (address uri display-name)
+</pre>
+ <pre id="var-docstr">Create a new Address object using a URI.
+It useful to create the To header etc.</pre>
+
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/address?">address?</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (address? object)
+</pre>
+ <pre id="var-docstr">Check the 'obj' is an instance of javax.sip.Address.</pre>
+
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/dialog?">dialog?</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (dialog? obj)
+</pre>
+ <pre id="var-docstr">Check the obj is an instance of 'javax.sip.Dialog'</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.4.0</span><br /></span>
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/header?">header?</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (header? object)
+</pre>
+ <pre id="var-docstr">Check whether the object is a Header or not</pre>
+
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/inc-sequence-number!">inc-sequence-number!</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (inc-sequence-number! request)
+</pre>
+ <pre id="var-docstr">Increase the sequence number of a request's CSeq header.</pre>
+
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/reason">reason</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (reason response)
+</pre>
+ <pre id="var-docstr">Gets the reason phrase of this Response message.</pre>
+
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/sip-address">sip-address</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (sip-address host &amp; {:keys [user port transport display-name], :as options})
+</pre>
+ <pre id="var-docstr">A convenient way to create a new Address object that limited to sip uri.
+
+(sip-address "localhost" :user "tom" :display-name "Tom" :port 5060 :transport "udp")</pre>
+
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/sip-uri">sip-uri</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (sip-uri host &amp; {:keys [user port transport]})
+</pre>
+ <pre id="var-docstr">Create a new SipURI object.
+
+(sip-uri "localhost" :port 5060 :transport "udp" :user "tom")</pre>
+
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/tel-uri">tel-uri</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (tel-uri phone-number)
+</pre>
+ <pre id="var-docstr">Create a new TelURI object with a phone number.
+
+(tel-uri 12345678) or (tel-uri "12345678")</pre>
+
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/transaction?">transaction?</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (transaction? obj)
+</pre>
+ <pre id="var-docstr">Check the obj is an instance of 'javax.sip.Transaction.'</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.core/uri?">uri?</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (uri? object)
+</pre>
+ <pre id="var-docstr">Check the 'obj' is an instance of javax.sip.URI.</pre>
+
+
+
+</div>
+
+
+</div>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div id="foot">
+ <div style="text-align: center;" id="copyright">No copyright info </div>
+ </div>
+ </div>
+ <div id="DesignedBy">Logo &amp; site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
+ Clojure auto-documentation system by Tom Faulhaber.</div>
+ </div>
+ <!-- /AllContentContainer -->
+ </body>
+
+</html>
View
71 cljain.dum-api.html
@@ -35,7 +35,7 @@
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
- <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.util-api.html" class="wiki_link">cljain.util</a></li>
+ <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.tools.predicate-api.html" class="wiki_link">cljain.tools.predicate</a></li><li><a href="cljain.tools.timer-api.html" class="wiki_link">cljain.tools.timer</a></li>
</ul>
</div>
@@ -54,8 +54,6 @@ <h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.dum/account">account</a>
</div><div style="margin-left: 1em;" class="toc-entry">
- <a href="#cljain.dum/account-map">account-map</a>
- </div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.dum/add-handler!">add-handler!</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.dum/def-request-handler">def-request-handler</a>
@@ -66,9 +64,13 @@ <h1 class="nopad">Table of Contents</h1>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.dum/legal-content?">legal-content?</a>
</div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.dum/register-to">register-to</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.dum/send-request!">send-request!</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.dum/send-response!">send-response!</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.dum/unregister-to">unregister-to</a>
</div>
<br />
</div>
@@ -81,8 +83,26 @@ <h1 class="nopad">Table of Contents</h1>
<br />Full namespace name: <span id="long-name">cljain.dum</span>
<p></p>
<h2>Overview</h2>
-<pre id="namespace-docstr">place doc string here</pre>
+<pre id="namespace-docstr">The DSL for SIP.
+Here is a simplest example show how to use it:
+
+ (use 'cljain.dum)
+ (require '[cljain.sip.core :as sip]
+ '[cljain.sip.address :as addr])
+ (def-request-handler :MESSAGE [request transaction dialog]
+ (println "Received: " (.getContent request))
+ (send-response! 200 :in transaction :pack "I receive your message."))
+
+ (sip/global-bind-sip-provider! (sip/sip-provider! "my-app" "localhost" 5060 "udp"))
+ (initialize! :user "bob" :domain "home" :display-name "Bob")
+ (sip/start!)
+
+ (send-request! :MESSAGE :to (addr/address "sip:alice@localhost") :pack "Hello, Alice."
+ :on-success (fn [_ _ response] (println "Fine! response: " (.getContent response)))
+ :on-failure (fn [_ _ response] (println "Oops!" (.getStatusCode response)))
+ :on-timeout (fn [_] (println "Timeout, try it later.")))</pre>
+<span class="ns-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
<br />
<h2>Public Variables and Functions</h2>
@@ -100,16 +120,6 @@ <h2 id="cljain.dum/account">account</h2>
</div><div id="var-entry">
<br />
<hr />
- <h2 id="cljain.dum/account-map">account-map</h2>
- <span id="var-type">var</span><br />
- <pre id="var-usage"></pre>
- <pre id="var-docstr">Store current account information, contain :user :domain :display-name</pre>
- <span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
-
-</div><div id="var-entry">
- <br />
- <hr />
<h2 id="cljain.dum/add-handler!">add-handler!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (add-handler! method process-fn)
@@ -149,7 +159,7 @@ <h2 id="cljain.dum/finalize!">finalize!</h2>
<hr />
<h2 id="cljain.dum/initialize!">initialize!</h2>
<span id="var-type">function</span><br />
- <pre id="var-usage">Usage: (initialize! &amp; account-info)
+ <pre id="var-usage">Usage: (initialize! &amp; {:keys [user domain display-name]})
</pre>
<pre id="var-docstr">Set the default user account information with the current bound provider.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
@@ -169,9 +179,25 @@ <h2 id="cljain.dum/legal-content?">legal-content?</h2>
</div><div id="var-entry">
<br />
<hr />
+ <h2 id="cljain.dum/register-to">register-to</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (register-to registry-address expires-seconds &amp; {:keys [on-success on-failure on-refreshed on-refresh-failed]})
+</pre>
+ <pre id="var-docstr">Send REGISTER sip message to target registry server, and auto refresh register before
+expired.
+
+Notice: No matter the first register whether sent successfully, the register auto refresh
+timer will be started. Application can choose to stop it use 'stop-refresh-register', or
+let it auto retry after expires secondes.</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.3.0</span><br /></span>
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
<h2 id="cljain.dum/send-request!">send-request!</h2>
<span id="var-type">function</span><br />
- <pre id="var-usage">Usage: (send-request! message &amp; options)
+ <pre id="var-usage">Usage: (send-request! message &amp; {to-address :to, dialog :in, on-timeout :on-timeout, transport :use, on-success :on-success, content :pack, more-headers :more-headers, from-address :from, on-failure :on-failure})
</pre>
<pre id="var-docstr">Fluent style sip message send function.
@@ -198,12 +224,23 @@ <h2 id="cljain.dum/send-request!">send-request!</h2>
<hr />
<h2 id="cljain.dum/send-response!">send-response!</h2>
<span id="var-type">function</span><br />
- <pre id="var-usage">Usage: (send-response! status-code &amp; options)
+ <pre id="var-usage">Usage: (send-response! status-code &amp; {transaction :in, content :pack, transport :use, more-headers :more-headers})
</pre>
<pre id="var-docstr">Send response with a server transactions.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.dum/unregister-to">unregister-to</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (unregister-to registry-address)
+</pre>
+ <pre id="var-docstr">Send REGISTER sip message with expires 0 for unregister.</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.3.0</span><br /></span>
+
+
</div>
View
1,819 cljain.sip-api.html
1,819 additions, 0 deletions not shown because the diff is too large. Please use a local Git client to view these changes.
View
29 cljain.sip.address-api.html
@@ -35,7 +35,7 @@
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
- <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.util-api.html" class="wiki_link">cljain.util</a></li>
+ <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.tools.predicate-api.html" class="wiki_link">cljain.tools.predicate</a></li><li><a href="cljain.tools.timer-api.html" class="wiki_link">cljain.tools.timer</a></li>
</ul>
</div>
@@ -56,6 +56,8 @@ <h1 class="nopad">Table of Contents</h1>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.address/address?">address?</a>
</div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.sip.address/sip-address">sip-address</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.address/sip-uri">sip-uri</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.address/tel-uri">tel-uri</a>
@@ -75,8 +77,8 @@ <h1 class="nopad">Table of Contents</h1>
<br />Full namespace name: <span id="long-name">cljain.sip.address</span>
<p></p>
<h2>Overview</h2>
-<pre id="namespace-docstr">place doc string here</pre>
-
+<pre id="namespace-docstr"></pre>
+<span class="ns-added"><span id="content">Added in cljain version 0.1.0</span><br /></span>
<br />
<h2>Public Variables and Functions</h2>
@@ -107,12 +109,24 @@ <h2 id="cljain.sip.address/address?">address?</h2>
</div><div id="var-entry">
<br />
<hr />
+ <h2 id="cljain.sip.address/sip-address">sip-address</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (sip-address host &amp; {:keys [user port transport display-name], :as options})
+</pre>
+ <pre id="var-docstr">A convenient way to create a new Address object that limited to sip uri.
+
+(sip-address "localhost" :user "tom" :display-name "Tom" :port 5060 :transport "udp")</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.4.0</span><br /></span>
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
<h2 id="cljain.sip.address/sip-uri">sip-uri</h2>
<span id="var-type">function</span><br />
- <pre id="var-usage">Usage: (sip-uri host &amp; options)
+ <pre id="var-usage">Usage: (sip-uri host &amp; {:keys [user port transport]})
</pre>
<pre id="var-docstr">Create a new SipURI object.
-It is useful to create the sip ReqURI or Address.
(sip-uri "localhost" :port 5060 :transport "udp" :user "tom")</pre>
<span class="var-added"><span id="content">Added in cljain version 0.1.0</span><br /></span>
@@ -138,9 +152,10 @@ <h2 id="cljain.sip.address/uri-from-address">uri-from-address</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (uri-from-address address)
</pre>
- <pre id="var-docstr">Get the URI member from a Address object.</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getURI' directly instead.
+Get the URI member from a Address object.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
View
35 cljain.sip.core-api.html
@@ -35,7 +35,7 @@
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
- <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.util-api.html" class="wiki_link">cljain.util</a></li>
+ <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.tools.predicate-api.html" class="wiki_link">cljain.tools.predicate</a></li><li><a href="cljain.tools.timer-api.html" class="wiki_link">cljain.tools.timer</a></li>
</ul>
</div>
@@ -56,6 +56,8 @@ <h1 class="nopad">Table of Contents</h1>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.core/already-bound-provider?">already-bound-provider?</a>
</div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.sip.core/dialog?">dialog?</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.core/gen-call-id-header">gen-call-id-header</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.core/global-bind-sip-provider!">global-bind-sip-provider!</a>
@@ -89,6 +91,8 @@ <h1 class="nopad">Table of Contents</h1>
<a href="#cljain.sip.core/start!">start!</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.core/stop-and-release!">stop-and-release!</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.sip.core/transaction?">transaction?</a>
</div>
<br />
</div>
@@ -101,8 +105,8 @@ <h1 class="nopad">Table of Contents</h1>
<br />Full namespace name: <span id="long-name">cljain.sip.core</span>
<p></p>
<h2>Overview</h2>
-<pre id="namespace-docstr">place doc string here</pre>
-
+<pre id="namespace-docstr"></pre>
+<span class="ns-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
<br />
<h2>Public Variables and Functions</h2>
@@ -131,6 +135,17 @@ <h2 id="cljain.sip.core/already-bound-provider?">already-bound-provider?</h2>
</div><div id="var-entry">
<br />
<hr />
+ <h2 id="cljain.sip.core/dialog?">dialog?</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (dialog? object)
+</pre>
+ <pre id="var-docstr">Check the obj is an instance of javax.sip.Dialog</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.4.0</span><br /></span>
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
<h2 id="cljain.sip.core/gen-call-id-header">gen-call-id-header</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (gen-call-id-header)
@@ -235,7 +250,7 @@ <h2 id="cljain.sip.core/send-request!">send-request!</h2>
<hr />
<h2 id="cljain.sip.core/set-listener!">set-listener!</h2>
<span id="var-type">function</span><br />
- <pre id="var-usage">Usage: (set-listener! &amp; processors)
+ <pre id="var-usage">Usage: (set-listener! &amp; {:keys [request response timeout io-exception transaction-terminated dialog-terminated]})
</pre>
<pre id="var-docstr">Set several event listening function to current bound provider.
Because JAIN-SIP just allow set listener once, if call 'set-listener' more then one times,
@@ -331,6 +346,18 @@ <h2 id="cljain.sip.core/stop-and-release!">stop-and-release!</h2>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.sip.core/transaction?">transaction?</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (transaction? object)
+</pre>
+ <pre id="var-docstr">Check the obj is an instance of javax.sip.Transaction.
+Both ClientTransaction and ServerTransaction are pass.</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.4.0</span><br /></span>
+
+
</div>
View
43 cljain.sip.dialog-api.html
@@ -35,7 +35,7 @@
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
- <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.util-api.html" class="wiki_link">cljain.util</a></li>
+ <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.tools.predicate-api.html" class="wiki_link">cljain.tools.predicate</a></li><li><a href="cljain.tools.timer-api.html" class="wiki_link">cljain.tools.timer</a></li>
</ul>
</div>
@@ -77,9 +77,9 @@ <h1 class="nopad">Table of Contents</h1>
<br />Full namespace name: <span id="long-name">cljain.sip.dialog</span>
<p></p>
<h2>Overview</h2>
-<pre id="namespace-docstr">place doc string here</pre>
-
-
+<pre id="namespace-docstr"></pre>
+<span class="ns-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+<span class="ns-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
@@ -89,10 +89,11 @@ <h2 id="cljain.sip.dialog/ack">ack</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (ack dialog seq-num)
</pre>
- <pre id="var-docstr">Creates an ACK request for an Invite that was responded with 2xx response.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'createAck' directly instead.
+Creates an ACK request for an Invite that was responded with 2xx response.
The cseq number for the invite is supplied to relate the ACK to its original invite request.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -101,9 +102,10 @@ <h2 id="cljain.sip.dialog/application-data">application-data</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (application-data dialog)
</pre>
- <pre id="var-docstr">Gets the application specific data specific to this dialog.</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getApplicationData' directly instead.
+Gets the application specific data specific to this dialog.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -112,9 +114,10 @@ <h2 id="cljain.sip.dialog/create-request">create-request</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (create-request dialog method)
</pre>
- <pre id="var-docstr">Creates a new Request message based on the dialog creating request.</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'createRequest' directly instead.
+Creates a new Request message based on the dialog creating request.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -123,9 +126,10 @@ <h2 id="cljain.sip.dialog/dialog?">dialog?</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (dialog? object)
</pre>
- <pre id="var-docstr">Check the obj is an instance of javax.sip.Dialog</pre>
+ <pre id="var-docstr">DEPRECATED: Use 'cljain.core/dialog?' instead.
+Check the obj is an instance of javax.sip.Dialog</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -134,12 +138,13 @@ <h2 id="cljain.sip.dialog/send-ack!">send-ack!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (send-ack! dialog ack)
</pre>
- <pre id="var-docstr">Sends ACK Request to the remote party of this dialog.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'sendAck' directly instead.
+Sends ACK Request to the remote party of this dialog.
This method implies that the application is functioning as User Agent Client
hence the underlying SipProvider acts statefully.
This method does not increment the local sequence number.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -148,9 +153,10 @@ <h2 id="cljain.sip.dialog/send-request!">send-request!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (send-request! dialog transaction)
</pre>
- <pre id="var-docstr">Sends a Request to the remote party of this dialog.</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'sendRequest' directly instead.
+Sends a Request to the remote party of this dialog.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -159,9 +165,10 @@ <h2 id="cljain.sip.dialog/set-application-data">set-application-data</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (set-application-data dialog data)
</pre>
- <pre id="var-docstr">Sets application specific data to this dialog.</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'setApplicationData' directly instead.
+Sets application specific data to this dialog.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div>
View
24 cljain.sip.header-api.html
@@ -35,7 +35,7 @@
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
- <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.util-api.html" class="wiki_link">cljain.util</a></li>
+ <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.tools.predicate-api.html" class="wiki_link">cljain.tools.predicate</a></li><li><a href="cljain.tools.timer-api.html" class="wiki_link">cljain.tools.timer</a></li>
</ul>
</div>
@@ -144,6 +144,8 @@ <h1 class="nopad">Table of Contents</h1>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.header/route">route</a>
</div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.sip.header/sequence-number">sequence-number</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.header/server">server</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.header/sip-etag">sip-etag</a>
@@ -183,8 +185,8 @@ <h1 class="nopad">Table of Contents</h1>
<br />Full namespace name: <span id="long-name">cljain.sip.header</span>
<p></p>
<h2>Overview</h2>
-<pre id="namespace-docstr">place doc string here</pre>
-
+<pre id="namespace-docstr"></pre>
+<span class="ns-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
<br />
<h2>Public Variables and Functions</h2>
@@ -482,9 +484,9 @@ <h2 id="cljain.sip.header/get-address">get-address</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (get-address header)
</pre>
- <pre id="var-docstr">place doc string here</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getAddress' directly instead.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -698,6 +700,18 @@ <h2 id="cljain.sip.header/route">route</h2>
</div><div id="var-entry">
<br />
<hr />
+ <h2 id="cljain.sip.header/sequence-number">sequence-number</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (sequence-number header)
+</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getSequenceNumber' directly instead.
+Get the sequence number from a CSeq header.</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.3.0</span><br /></span>
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
+
+</div><div id="var-entry">
+ <br />
+ <hr />
<h2 id="cljain.sip.header/server">server</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (server product)
View
93 cljain.sip.message-api.html
@@ -35,7 +35,7 @@
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
- <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.util-api.html" class="wiki_link">cljain.util</a></li>
+ <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.tools.predicate-api.html" class="wiki_link">cljain.tools.predicate</a></li><li><a href="cljain.tools.timer-api.html" class="wiki_link">cljain.tools.timer</a></li>
</ul>
</div>
@@ -54,12 +54,20 @@ <h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.message/add-header!">add-header!</a>
</div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.sip.message/content">content</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.message/header">header</a>
</div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.sip.message/inc-sequence-number!">inc-sequence-number!</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.message/method">method</a>
</div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.sip.message/raw-content">raw-content</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.message/reason">reason</a>
</div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.sip.message/remove-content!">remove-content!</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.message/remove-header!">remove-header!</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#cljain.sip.message/request">request</a>
@@ -83,8 +91,8 @@ <h1 class="nopad">Table of Contents</h1>
<br />Full namespace name: <span id="long-name">cljain.sip.message</span>
<p></p>
<h2>Overview</h2>
-<pre id="namespace-docstr">place doc string here</pre>
-
+<pre id="namespace-docstr"></pre>
+<span class="ns-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
<br />
<h2>Public Variables and Functions</h2>
@@ -95,7 +103,8 @@ <h2 id="cljain.sip.message/add-header!">add-header!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (add-header! message header)
</pre>
- <pre id="var-docstr">The Header is added to the end of the List and will appear in that order in the SIP Message.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'addHeader' directly instead.
+The Header is added to the end of the List and will appear in that order in the SIP Message.
Required Headers that are singletons should not be added to the message as they already
exist in the message and therefore should be changed using the 'set-header!' method.
@@ -103,7 +112,19 @@ <h2 id="cljain.sip.message/add-header!">add-header!</h2>
When adding a ViaHeader using this method the implementation will add the ViaHeader to the
top of the ViaHeader list, and not the end like all other Headers.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.sip.message/content">content</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (content message)
+</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getContent' directly instead.
+Gets the body content of the Message as an Object.</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.3.0</span><br /></span>
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -112,10 +133,22 @@ <h2 id="cljain.sip.message/header">header</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (header message header-name)
</pre>
- <pre id="var-docstr">Gets the Header of the specified name in this Message.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getHeader' directly instead.
+Gets the Header of the specified name in this Message.
If multiple Headers of this header name exist in the message,
the first header in the message is returned.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.sip.message/inc-sequence-number!">inc-sequence-number!</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (inc-sequence-number! request)
+</pre>
+ <pre id="var-docstr">Increase the sequence number of a request's CSeq header.</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.3.0</span><br /></span>
</div><div id="var-entry">
@@ -125,9 +158,22 @@ <h2 id="cljain.sip.message/method">method</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (method request)
</pre>
- <pre id="var-docstr">Gets method string of this Request message.</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getMethod' directly instead.
+Gets method string of this Request message.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.sip.message/raw-content">raw-content</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (raw-content message)
+</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getRawContent' directly instead.
+Gets the body content of the Message as a byte array.</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.3.0</span><br /></span>
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -143,17 +189,31 @@ <h2 id="cljain.sip.message/reason">reason</h2>
</div><div id="var-entry">
<br />
<hr />
+ <h2 id="cljain.sip.message/remove-content!">remove-content!</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (remove-content! message)
+</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'removeContent' directly instead.
+Removes the body content from this Message and all associated entity headers,
+if a body exists, this method returns sliently if no body exists.</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.3.0</span><br /></span>
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
+
+</div><div id="var-entry">
+ <br />
+ <hr />
<h2 id="cljain.sip.message/remove-header!">remove-header!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (remove-header! message header-name)
</pre>
- <pre id="var-docstr">Removes the Header of the supplied name from the list of headers in this Message.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'removeHeader' directly instead.
+Removes the Header of the supplied name from the list of headers in this Message.
If multiple headers exist then they are all removed from the header list.
If no headers exist then this method returns silently.
This method should not be used to remove required Headers, required Headers should be
replaced using the 'set-header!'.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -175,7 +235,7 @@ <h2 id="cljain.sip.message/response">response</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (response status-code reqest &amp; more-headers)
</pre>
- <pre id="var-docstr">Creates a new Response message of type specified by the statusCode paramater,
+ <pre id="var-docstr">Creates a new Response message of type specified by the status-code paramater,
based on a specific Request message. This new Response does not contain a body.
Only the required headers are copied from the Request.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
@@ -188,13 +248,14 @@ <h2 id="cljain.sip.message/set-content!">set-content!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (set-content! message type-header content)
</pre>
- <pre id="var-docstr">Sets the new Header to replace existings Header of that type in the message.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'setContent' directly instead.
+Sets the new Header to replace existings Header of that type in the message.
If the SIP message contains more than one Header of the new Header type it should
replace the first occurance of this Header and removes all other Headers of this type.
If no Header of this type exists this header is added to the end of the SIP Message.
This method should be used to change required Headers and overwrite optional Headers.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -203,13 +264,14 @@ <h2 id="cljain.sip.message/set-header!">set-header!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (set-header! message header)
</pre>
- <pre id="var-docstr">Sets the new Header to replace existings Header of that type in the message.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'setHeader' directly instead.
+Sets the new Header to replace existings Header of that type in the message.
If the SIP message contains more than one Header of the new Header type it should
replace the first occurance of this Header and removes all other Headers of this type.
If no Header of this type exists this header is added to the end of the SIP Message.
This method should be used to change required Headers and overwrite optional Headers.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -218,10 +280,11 @@ <h2 id="cljain.sip.message/status-code">status-code</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (status-code response)
</pre>
- <pre id="var-docstr">Gets the integer value of the status code of Response,
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getStatusCode' directly instead.
+Gets the integer value of the status code of Response,
which identifies the outcome of the request to which this response is related.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div>
View
45 cljain.sip.transaction-api.html
@@ -35,7 +35,7 @@
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
- <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.util-api.html" class="wiki_link">cljain.util</a></li>
+ <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.tools.predicate-api.html" class="wiki_link">cljain.tools.predicate</a></li><li><a href="cljain.tools.timer-api.html" class="wiki_link">cljain.tools.timer</a></li>
</ul>
</div>
@@ -77,9 +77,9 @@ <h1 class="nopad">Table of Contents</h1>
<br />Full namespace name: <span id="long-name">cljain.sip.transaction</span>
<p></p>
<h2>Overview</h2>
-<pre id="namespace-docstr">place doc string here</pre>
-
-
+<pre id="namespace-docstr"></pre>
+<span class="ns-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+<span class="ns-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
@@ -89,10 +89,11 @@ <h2 id="cljain.sip.transaction/application-data">application-data</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (application-data transaction)
</pre>
- <pre id="var-docstr">Returns the application data associated with the transaction.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getApplicationData' directly instead.
+Returns the application data associated with the transaction.
This specification does not define the format of this application specific data.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -101,7 +102,8 @@ <h2 id="cljain.sip.transaction/branch-id">branch-id</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (branch-id transaction)
</pre>
- <pre id="var-docstr">Returns a unique branch identifer that identifies this transaction.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getBranchId' directly instead.
+Returns a unique branch identifer that identifies this transaction.
The branch identifier is used in the ViaHeader. The uniqueness property of the
branch ID parameter to facilitate its use as a transaction ID, was not part of RFC 2543.
The branch ID inserted by an element compliant with the RFC3261 specification MUST always
@@ -109,8 +111,8 @@ <h2 id="cljain.sip.transaction/branch-id">branch-id</h2>
so that servers receiving the request can determine that the branch ID was constructed
to be globally unique. The precise format of the branch token is implementation-defined.
This method should always return the same branch identifier for the same transaction.</pre>
- <span class="var-added"><span id="content">Added in cljain version VERSION</span><br /></span>
-
+ <span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -119,13 +121,14 @@ <h2 id="cljain.sip.transaction/request">request</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (request transaction)
</pre>
- <pre id="var-docstr">Returns the request that created this transaction.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'getRequest' directly instead.
+Returns the request that created this transaction.
The transaction state machine needs to keep the Request that resulted in the creation
of this transaction while the transaction is still alive. Applications also need to access
this information, e.g. a forking proxy server may wish to retrieve the original Invite
request to cancel branches of a fork when a final Response has been received by one branch.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -134,7 +137,8 @@ <h2 id="cljain.sip.transaction/send-request!">send-request!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (send-request! client-transaction)
</pre>
- <pre id="var-docstr">Sends the Request which created this ClientTransaction.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'sendRequest' directly instead.
+Sends the Request which created this ClientTransaction.
When an application wishes to send a Request message, it creates a Request from the
MessageFactory and then creates a new ClientTransaction from 'cljain.core/new-client-transcation!'.
Calling this method on the ClientTransaction sends the Request onto the network.
@@ -149,7 +153,7 @@ <h2 id="cljain.sip.transaction/send-request!">send-request!</h2>
This method implies that the application is functioning as either a UAC or a stateful proxy,
hence the underlying implementation acts statefully.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -158,7 +162,8 @@ <h2 id="cljain.sip.transaction/send-response!">send-response!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (send-response! server-transaction response)
</pre>
- <pre id="var-docstr">Sends the Response to a Request which is associated with this ServerTransaction.
+ <pre id="var-docstr">DEPRECATED: Use Java method 'sendResponse' directly instead.
+Sends the Response to a Request which is associated with this ServerTransaction.
When an application wishes to send a Response, it creates a Response using the
MessageFactory and then passes that Response to this method. The Response message
gets sent out on the network via the ListeningPoint information that is associated
@@ -171,7 +176,7 @@ <h2 id="cljain.sip.transaction/send-response!">send-response!</h2>
removing ServerTransaction record from memory to catch retransmissions of the INVITE
in accordance with the reccomendation of <a href="http://bugs.sipit.net/show_bug.cgi?id=769">http://bugs.sipit.net/show_bug.cgi?id=769</a> .</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -180,9 +185,10 @@ <h2 id="cljain.sip.transaction/set-application-data!">set-application-data!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (set-application-data! transaction data)
</pre>
- <pre id="var-docstr">This method allows applications to associate application context with the transaction.</pre>
+ <pre id="var-docstr">DEPRECATED: Use Java method 'setApplicationData' directly instead.
+This method allows applications to associate application context with the transaction.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div><div id="var-entry">
<br />
@@ -191,10 +197,11 @@ <h2 id="cljain.sip.transaction/transaction?">transaction?</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (transaction? object)
</pre>
- <pre id="var-docstr">Check the obj is an instance of javax.sip.Transaction.
+ <pre id="var-docstr">DEPRECATED: Use 'cljain.core/transaction?' instead.
+Check the obj is an instance of javax.sip.Transaction.
Both ClientTransaction and ServerTransaction are pass.</pre>
<span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
-
+ <span class="var-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
</div>
View
141 cljain.tools.predicate-api.html
@@ -0,0 +1,141 @@
+<html>
+ <head>
+ <title>cljain.tools.predicate - cljain API documentation</title>
+ <link href="static/favicon.png" rel="icon" />
+ <link href="static/favicon.png" rel="shortcut icon" />
+ <link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
+ <link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
+ <link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
+ <style>.menuWrapper{height: 36px;}</style>
+ <!--[if lte IE 6]>
+ <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
+ <![endif]-->
+ </head>
+<!--
+This document was auto-generated from the source by the clojure autodoc system.
+To report errors or ask questions about the overall documentation structure, formatting,
+etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
+For errors in the documentation of a particular namespace, contact the author of that
+namespace.
+-->
+ <body>
+ <div id="AllContentContainer">
+ <div id="Header">
+ <a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
+ <h1><a title="page header title" id="page-header" href="index.html">cljain API Documentation</a></h1>
+ </div>
+ <div id="leftcolumn"><div style="text-align: center;"></div>
+<div class="menu">
+ <div class="WikiCustomNav WikiElement wiki">
+ <span class="toc-header"><span id="project-name">cljain</span> <span id="version"></span> API</span><br />
+ <ul>
+ <li><a class="wiki_link" href="index.html">Overview</a></li>
+ <li><a class="wiki_link" href="api-index.html">API Index</a></li>
+ </ul>
+ <div class="NamespaceTOC">
+ <span class="toc-header">Namespaces</span>
+ <ul id="left-sidebar-list">
+ <li><a href="cljain.dum-api.html" class="wiki_link">cljain.dum</a></li><li><a href="cljain.sip.address-api.html" class="wiki_link">cljain.sip.address</a></li><li><a href="cljain.sip.core-api.html" class="wiki_link">cljain.sip.core</a></li><li><a href="cljain.sip.dialog-api.html" class="wiki_link">cljain.sip.dialog</a></li><li><a href="cljain.sip.header-api.html" class="wiki_link">cljain.sip.header</a></li><li><a href="cljain.sip.message-api.html" class="wiki_link">cljain.sip.message</a></li><li><a href="cljain.sip.transaction-api.html" class="wiki_link">cljain.sip.transaction</a></li><li><a href="cljain.tools.predicate-api.html" class="wiki_link">cljain.tools.predicate</a></li><li><a href="cljain.tools.timer-api.html" class="wiki_link">cljain.tools.timer</a></li>
+ </ul>
+ </div>
+
+ <a href="http://clojure.org" class="wiki_link">Clojure Home</a>
+ </div>
+</div>
+</div>
+ <div id="rightcolumn">
+ <div id="Content">
+ <div class="contentBox"><div class="innerContentBox">
+ <div id="content_view" class="wiki wikiPage">
+ <div id="right-sidebar"><div id="toc">
+ <h1 class="nopad">Table of Contents</h1>
+ <div style="margin-left: 1em;" class="toc-section">
+ <a href="#toc0">Overview</a>
+ <div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.tools.predicate/check-optional">check-optional</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.tools.predicate/check-required">check-required</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.tools.predicate/in?">in?</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#cljain.tools.predicate/legal-option?">legal-option?</a>
+ </div>
+ <br />
+ </div>
+</div>
+</div>
+ <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">cljain.tools.predicate</span>
+ - <span id="header-project">cljain</span> <span id="header-version"></span>
+ </h1>
+<span id="author-line">by <span id="author-name">ruiyun</span><br /></span>
+<br />Full namespace name: <span id="long-name">cljain.tools.predicate</span>
+<p></p>
+<h2>Overview</h2>
+<pre id="namespace-docstr"></pre>
+<span class="ns-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+<span class="ns-deprecated"><span id="content">Deprecated since cljain version 0.4.0</span><br /></span>
+<br />
+<h2>Public Variables and Functions</h2>
+<div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.tools.predicate/check-optional">check-optional</h2>
+ <span id="var-type">macro</span><br />
+ <pre id="var-usage">Usage: (check-optional options option-key :by? option-modifier? f &amp; args)
+</pre>
+ <pre id="var-docstr">place doc string here</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.tools.predicate/check-required">check-required</h2>
+ <span id="var-type">macro</span><br />
+ <pre id="var-usage">Usage: (check-required options option-key :by? option-modifier? f &amp; args)
+</pre>
+ <pre id="var-docstr">place doc string here</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.tools.predicate/in?">in?</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (in? v coll)
+</pre>
+ <pre id="var-docstr">Chekc whether v is in the coll or not.</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
+ <h2 id="cljain.tools.predicate/legal-option?">legal-option?</h2>
+ <span id="var-type">macro</span><br />
+ <pre id="var-usage">Usage: (legal-option? required? &amp; decl)
+</pre>
+ <pre id="var-docstr">place doc string here</pre>
+ <span class="var-added"><span id="content">Added in cljain version 0.2.0</span><br /></span>
+
+
+</div>
+
+
+</div>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div id="foot">
+ <div style="text-align: center;" id="copyright">No copyright info </div>
+ </div>
+ </div>
+ <div id="DesignedBy">Logo &amp; site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
+ Clojure auto-documentation system by Tom Faulhaber.</div>
+ </div>
+ <!-- /AllContentContainer -->
+ </body>
+
+</html>
View
142 cljain.tools.timer-api.html
@@ -0,0 +1,142 @@
+<html>
+ <head>
+ <title>cljain.tools.timer - cljain API documentation</title>
+ <link href="static/favicon.png" rel="icon" />
+ <link href="static/favicon.png" rel="shortcut icon" />
+ <link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
+ <link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
+ <link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
+ <style>.menuWrapper{height: 36px;}</style>
+ <!--[if lte IE 6]>
+ <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
+ <![endif]-->
+ </head>
+<!--
+This document was auto-generated from the source by the clojure autodoc system.
+To report errors or ask questions about the overall documentation structure, formatting,
+etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
+For errors in the documentation of a particular namespace, contact the author of that
+namespace.
+-->
+ <body>
+ <div id="AllContentContainer">
+ <div id="Header">
+ <a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
+ <h1><a title="page header title" id="page-header" href="index.html">cljain API Documentation</a></h1>
+ </div>
+ <div id="leftcolumn"><div style="text-align: center;"></div>
+<div class="menu">
+ <div class="WikiCustomNav WikiElement wiki">
+ <span class="toc-header"><span id="project-name">cljain</span> <span id="version"></span> API</span><br />
+ <