<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[Freeswitch-trunk][16148] </title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<div id="header">FreeSWITCH Subversion</div>
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://fisheye.freeswitch.org/changelog/FreeSWITCH?cs=16148">16148</a></dd>
<dt>Author</dt> <dd>dvarnes</dd>
<dt>Date</dt> <dd>2010-01-05 05:31:24 -0600 (Tue, 05 Jan 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add docs to SendMsg</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#freeswitchtrunkcontribdvarnesjavaeslclientorgfreeswitcheslclientsrcmainjavaorgfreeswitcheslclienttransportSendMsgjava">freeswitch/trunk/contrib/dvarnes/java/esl-client/org.freeswitch.esl.client/src/main/java/org/freeswitch/esl/client/transport/SendMsg.java</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="freeswitchtrunkcontribdvarnesjavaeslclientorgfreeswitcheslclientsrcmainjavaorgfreeswitcheslclienttransportSendMsgjava"></a>
<div class="modfile"><h4>Modified: freeswitch/trunk/contrib/dvarnes/java/esl-client/org.freeswitch.esl.client/src/main/java/org/freeswitch/esl/client/transport/SendMsg.java (16147 => 16148)</h4>
<pre class="diff"><span>
<span class="info">--- freeswitch/trunk/contrib/dvarnes/java/esl-client/org.freeswitch.esl.client/src/main/java/org/freeswitch/esl/client/transport/SendMsg.java 2010-01-05 07:01:37 UTC (rev 16147)
+++ freeswitch/trunk/contrib/dvarnes/java/esl-client/org.freeswitch.esl.client/src/main/java/org/freeswitch/esl/client/transport/SendMsg.java 2010-01-05 11:31:24 UTC (rev 16148)
</span><span class="lines">@@ -1,3 +1,18 @@
</span><ins>+/*
+ * Copyright 2010 david varnes.
+ *
+ * Licensed under the Apache License, version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
</ins><span class="cx"> package org.freeswitch.esl.client.transport;
</span><span class="cx">
</span><span class="cx"> import java.util.ArrayList;
</span><span class="lines">@@ -3,61 +18,169 @@
</span><span class="cx"> import java.util.List;
</span><span class="cx">
</span><ins>+/**
+ *
+ * @author david varnes
+ * @version $Id$
+ */
</ins><span class="cx"> public class SendMsg
</span><span class="cx"> {
</span><span class="cx"> private final List<String> msgLines = new ArrayList<String>();
</span><ins>+ private final boolean hasUuid;
</ins><span class="cx">
</span><ins>+ /**
+ * Constructor for use with outbound socket client only. This client mode does not need a call
+ * UUID for context.
+ */
</ins><span class="cx"> public SendMsg()
</span><span class="cx"> {
</span><span class="cx"> msgLines.add( "sendmsg" );
</span><ins>+ hasUuid = false;
</ins><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Constructor for use with the inbound client.
+ *
+ * @param uuid of the call to send message to (it should be in 'park' to be operated on).
+ */
</ins><span class="cx"> public SendMsg( String uuid )
</span><span class="cx"> {
</span><span class="cx"> msgLines.add( "sendmsg " + uuid );
</span><ins>+ hasUuid = true;
</ins><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Adds the following line to the message:
+ * <pre>
+ * call-command: command
+ * </pre>
+ * @param command the string command [ execute | hangup ]
+ */
</ins><span class="cx"> public void addCallCommand( String command )
</span><span class="cx"> {
</span><span class="cx"> msgLines.add( "call-command: " + command );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Adds the following line to the message:
+ * <pre>
+ * execute-app-name: appName
+ * </pre>
+ * @param appName the string app name to execute
+ */
</ins><span class="cx"> public void addExecuteAppName( String appName )
</span><span class="cx"> {
</span><span class="cx"> msgLines.add( "execute-app-name: " + appName );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Adds the following line to the message:
+ * <pre>
+ * execute-app-arg: arg
+ * </pre>
+ * @param arg the string arg
+ */
</ins><span class="cx"> public void addExecuteAppArg( String arg )
</span><span class="cx"> {
</span><span class="cx"> msgLines.add( "execute-app-arg: " + arg );
</span><span class="cx"> }
</span><del>-
</del><ins>+
+ /**
+ * Adds the following line to the message:
+ * <pre>
+ * loops: count
+ * </pre>
+ * @param count the int number of times to loop
+ */
</ins><span class="cx"> public void addLoops( int count )
</span><span class="cx"> {
</span><span class="cx"> msgLines.add( "loops: " + count );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Adds the following line to the message:
+ * <pre>
+ * hangup-cause: cause
+ * </pre>
+ * @param cause the string cause
+ */
</ins><span class="cx"> public void addHangupCause( String cause )
</span><span class="cx"> {
</span><span class="cx"> msgLines.add( "hangup-cause: " + cause );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- public void addNomediaUuid( String info )
</del><ins>+ /**
+ * Adds the following line to the message:
+ * <pre>
+ * nomedia-uid: value
+ * </pre>
+ * @param value the string value part of the line
+ */
+ public void addNomediaUuid( String value )
</ins><span class="cx"> {
</span><del>- msgLines.add( "nomedia-uuid: " + info );
</del><ins>+ msgLines.add( "nomedia-uuid: " + value );
</ins><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Adds the following line to the message:
+ * <pre>
+ * event-lock: true
+ * </pre>
+ */
</ins><span class="cx"> public void addEventLock()
</span><span class="cx"> {
</span><span class="cx"> msgLines.add( "event-lock: true" );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * A generic method to add a message line. The constructed line in the sent message will be in the
+ * form:
+ * <pre>
+ * name: value
+ * </pre>
+ *
+ * @param name part of line
+ * @param value part of line
+ */
</ins><span class="cx"> public void addGenericLine( String name, String value )
</span><span class="cx"> {
</span><span class="cx"> msgLines.add( name + ": " + value );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * The list of strings that make up the message to send to FreeSWITCH.
+ *
+ * @return list of strings, as they were added to this message.
+ */
</ins><span class="cx"> public List<String> getMsgLines()
</span><span class="cx"> {
</span><span class="cx"> return msgLines;
</span><span class="cx"> }
</span><ins>+
+ /**
+ * Indicate if message was constructed with a UUID.
+ *
+ * @return true if constructed with a UUID.
+ */
+ public boolean hasUuid()
+ {
+ return hasUuid;
+ }
+
+ @Override
+ public String toString()
+ {
+ StringBuilder sb = new StringBuilder( "SendMsg: " );
+ if ( msgLines.size() > 1 )
+ {
+ sb.append( msgLines.get( 1 ) );
+ }
+ else if ( msgLines.size() > 0 )
+ {
+ sb.append( 0 );
+ }
+
+ return sb.toString();
+ }
+
+
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
<div id="footer">See you at ClueCon</div>
</body>
</html>