1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
|
<HTML>
<HEAD>
<TITLE>class ClientLogic</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class ClientLogic</h1>
</TD>
<TD valign="top" align="right" colspan="1">Base class for all client logics. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::ClientLogic</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="yatecbase_h.html">yatecbase.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__GenObject.html">TelEngine::GenObject</A> <small>[public ]</small></TD></TR>
<TR><TH>Inherited by</TH><TD><A HREF="TelEngine__DefaultLogic.html">DefaultLogic</A></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__ClientLogic.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI>virtual <b><A HREF="#ref2">~ClientLogic</A></b> ()
</LI>
<LI>inline const String& <b><A HREF="#ref3">name</A></b> () const
</LI>
<LI>inline int <b><A HREF="#ref4">priority</A></b> () const
</LI>
<LI>virtual const String& <b><A HREF="#ref5">toString</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref6">setParams</A></b> (const NamedList& params)
</LI>
<LI>virtual bool <b><A HREF="#ref7">action</A></b> (Window* wnd, const String& name, NamedList* params = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref8">toggle</A></b> (Window* wnd, const String& name, bool active)
</LI>
<LI>virtual bool <b><A HREF="#ref9">select</A></b> (Window* wnd, const String& name, const String& item,
const String& text = String::empty())
</LI>
<LI>virtual bool <b><A HREF="#ref10">setClientParam</A></b> (const String& param, const String& value,
bool save, bool update)
</LI>
<LI>virtual bool <b><A HREF="#ref11">imIncoming</A></b> (Message& msg)
</LI>
<LI>virtual bool <b><A HREF="#ref12">callIncoming</A></b> (Message& msg, const String& dest)
</LI>
<LI>virtual bool <b><A HREF="#ref13">callStart</A></b> (NamedList& params, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref14">line</A></b> (const String& name, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref15">display</A></b> (NamedList& params, bool widget, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref16">backspace</A></b> (const String& name, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref17">command</A></b> (const String& name, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref18">debug</A></b> (const String& name, bool active, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref19">editAccount</A></b> (bool newAcc, NamedList* params, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref20">acceptAccount</A></b> (NamedList* params, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref21">delAccount</A></b> (const String& account, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref22">updateAccount</A></b> (const NamedList& account, bool login, bool save)
</LI>
<LI>virtual bool <b><A HREF="#ref23">loginAccount</A></b> (const NamedList& account, bool login)
</LI>
<LI>virtual bool <b><A HREF="#ref24">updateContact</A></b> (const NamedList& contact, bool save, bool update)
</LI>
<LI>virtual bool <b><A HREF="#ref25">acceptContact</A></b> (NamedList* params, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref26">editContact</A></b> (bool newCont, NamedList* params = 0, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref27">delContact</A></b> (const String& contact, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref28">callContact</A></b> (NamedList* params = 0, Window* wnd = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref29">updateProviders</A></b> (const NamedList& provider, bool save, bool update)
</LI>
<LI>virtual bool <b><A HREF="#ref30">callLogUpdate</A></b> (NamedList& params, bool save, bool update)
</LI>
<LI>virtual bool <b><A HREF="#ref31">callLogClear</A></b> (const String& table, const String& direction)
</LI>
<LI>virtual bool <b><A HREF="#ref32">callLogCall</A></b> (const String& billid)
</LI>
<LI>virtual bool <b><A HREF="#ref33">callLogCreateContact</A></b> (const String& billid)
</LI>
<LI>virtual bool <b><A HREF="#ref34">help</A></b> (const String& action, Window* wnd)
</LI>
<LI>virtual bool <b><A HREF="#ref35">calltoLoaded</A></b> ()
</LI>
<LI>virtual void <b><A HREF="#ref36">loadedWindows</A></b> ()
</LI>
<LI>virtual void <b><A HREF="#ref37">initializedWindows</A></b> ()
</LI>
<LI>virtual bool <b><A HREF="#ref38">initializedClient</A></b> ()
</LI>
<LI>virtual void <b><A HREF="#ref39">exitingClient</A></b> ()
</LI>
<LI>virtual bool <b><A HREF="#ref40">handleUiAction</A></b> (Message& msg, bool& stopLogic)
</LI>
<LI>virtual bool <b><A HREF="#ref41">handleCallCdr</A></b> (Message& msg, bool& stopLogic)
</LI>
<LI>virtual bool <b><A HREF="#ref42">handleUserLogin</A></b> (Message& msg, bool& stopLogic)
</LI>
<LI>virtual bool <b><A HREF="#ref43">handleUserNotify</A></b> (Message& msg, bool& stopLogic)
</LI>
<LI>virtual bool <b><A HREF="#ref44">handleResourceNotify</A></b> (Message& msg, bool& stopLogic)
</LI>
<LI>virtual bool <b><A HREF="#ref45">handleResourceSubscribe</A></b> (Message& msg, bool& stopLogic)
</LI>
<LI>virtual bool <b><A HREF="#ref46">handleClientChanUpdate</A></b> (Message& msg, bool& stopLogic)
</LI>
<LI>virtual bool <b><A HREF="#ref47">defaultMsgHandler</A></b> (Message& msg, int id, bool& stopLogic)
</LI>
<LI>virtual void <b><A HREF="#ref48">engineStart</A></b> (Message& msg)
</LI>
<LI>virtual bool <b><A HREF="#ref49">addDurationUpdate</A></b> (DurationUpdate* duration, bool autoDelete = false)
</LI>
<LI>virtual bool <b><A HREF="#ref50">removeDurationUpdate</A></b> (const String& name, bool delObj = false)
</LI>
<LI>virtual bool <b><A HREF="#ref51">removeDurationUpdate</A></b> (DurationUpdate* duration, bool delObj = false)
</LI>
<LI>virtual DurationUpdate* <b><A HREF="#ref52">findDurationUpdate</A></b> (const String& name, bool ref = true)
</LI>
<LI>virtual void <b><A HREF="#ref53">clearDurationUpdate</A></b> ()
</LI>
<LI>virtual void <b><A HREF="#ref54">destruct</A></b> ()
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static void <b><A HREF="#ref55">initStaticData</A></b> ()
</LI>
</ul><h4>Public Members</h4><ul><LI>static ObjList <b><A HREF="#ref56">s_accOptions</A></b></LI>
<LI>static const char* <b><A HREF="#ref57">s_provParams[]</A></b></LI>
</ul><h4>Protected Methods</h4><ul><LI> <b><A HREF="#ref58">ClientLogic</A></b> (const char* name, int priority)
</LI>
<LI>virtual void <b><A HREF="#ref59">idleTimerTick</A></b> (Time& time)
</LI>
</ul><h4>Protected Members</h4><ul><LI>static ObjList <b><A HREF="#ref60">s_protocols</A></b></LI>
<LI>static Mutex <b><A HREF="#ref61">s_protocolsMutex</A></b></LI>
<LI>ObjList <b><A HREF="#ref62">m_durationUpdate</A></b></LI>
<LI>Mutex <b><A HREF="#ref63">m_durationMutex</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
This class implements the logic behind different actions in the client.
It specifies the way the graphical interface of the client will behave
in different circumstances.
</p>
<A NAME="~ClientLogic"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~ClientLogic</strong> ()
<br></td><td align="right"><h3><strong>~ClientLogic</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor. Remove itself from the client's list
</p>
<A NAME="name"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>name</strong> ()
<br></td><td align="right"><h3><strong>name</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the name of this logic
</p>
<p><b>Returns</b>: This logic's name
</p>
<A NAME="priority"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>priority</strong> ()
<br></td><td align="right"><h3><strong>priority</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the priority of this logic
</p>
<p><b>Returns</b>: This logic's priority
</p>
<A NAME="toString"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> const String& <strong>toString</strong> ()
<br></td><td align="right"><h3><strong>toString</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Function that returns the name of the logic
</p>
<p><b>Returns</b>: The name of this client logic
</p>
<p>Reimplemented from <A HREF="TelEngine__GenObject.html#toString">GenObject</A>.</p>
<A NAME="setParams"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>setParams</strong> (const NamedList& params)
<br></td><td align="right"><h3><strong>setParams</strong></h3></td></tr></table><p></p><p>
Process a request to set client parameters
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">The parameter list
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="action"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>action</strong> (Window* wnd, const String& name, NamedList* params = 0)
<br></td><td align="right"><h3><strong>action</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Handle actions from user interface
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">The window in which the user did something
</TD></TR>
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The action's name
</TD></TR>
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Optional action parameters
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the action was handled
</p>
<A NAME="toggle"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>toggle</strong> (Window* wnd, const String& name, bool active)
<br></td><td align="right"><h3><strong>toggle</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Handle actions from checkable widgets
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">The window in which the user did something
</TD></TR>
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The object's name
</TD></TR>
<TR><TD align="left" valign="top"><i>active</i></TD><TD align="left" valign="top">Object's state
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the action was handled by a client logic
</p>
<A NAME="select"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>select</strong> (Window* wnd, const String& name, const String& item,
const String& text = String::empty())
<br></td><td align="right"><h3><strong>select</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Handle 'select' actions from user interface
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">The window in which the user did something
</TD></TR>
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The object's name
</TD></TR>
<TR><TD align="left" valign="top"><i>item</i></TD><TD align="left" valign="top">Item identifying the selection
</TD></TR>
<TR><TD align="left" valign="top"><i>text</i></TD><TD align="left" valign="top">Selection's text
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the action was handled
</p>
<A NAME="setClientParam"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>setClientParam</strong> (const String& param, const String& value,
bool save, bool update)
<br></td><td align="right"><h3><strong>setClientParam</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Set a client's parameter. Save the settings file and/or update interface
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>param</i></TD><TD align="left" valign="top">Parameter's name
</TD></TR>
<TR><TD align="left" valign="top"><i>value</i></TD><TD align="left" valign="top">The value of the parameter
</TD></TR>
<TR><TD align="left" valign="top"><i>save</i></TD><TD align="left" valign="top">True to save the configuration file
</TD></TR>
<TR><TD align="left" valign="top"><i>update</i></TD><TD align="left" valign="top">True to update the interface
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="imIncoming"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>imIncoming</strong> (Message& msg)
<br></td><td align="right"><h3><strong>imIncoming</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process an IM message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">The im.execute or chan.text message
</TD></TR>
</TABLE></P>
<A NAME="callIncoming"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>callIncoming</strong> (Message& msg, const String& dest)
<br></td><td align="right"><h3><strong>callIncoming</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Call execute handler called by the client.
The default logic ask the client to build an incoming channel
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">The call.execute message
</TD></TR>
<TR><TD align="left" valign="top"><i>dest</i></TD><TD align="left" valign="top">The destination (target)
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if a channel was created and connected
</p>
<A NAME="callStart"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>callStart</strong> (NamedList& params, Window* wnd = 0)
<br></td><td align="right"><h3><strong>callStart</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called when the user trigger a call start action
The default logic fill the parameter list and ask the client to create an outgoing channel
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">List of call parameters
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="line"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>line</strong> (const String& name, Window* wnd = 0)
<br></td><td align="right"><h3><strong>line</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called when the user selected a line
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The line name
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="display"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>display</strong> (NamedList& params, bool widget, Window* wnd = 0)
<br></td><td align="right"><h3><strong>display</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Show/hide widget(s) or window(s) on 'display'/'show' action.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Widget(s) or window(s) to show/hide
</TD></TR>
<TR><TD align="left" valign="top"><i>widget</i></TD><TD align="left" valign="top">True if the operation indicates widget(s), false otherwise
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window owning the widget(s) to show or hide
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: False if failed to show/hide all widgets/windows
</p>
<A NAME="backspace"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>backspace</strong> (const String& name, Window* wnd = 0)
<br></td><td align="right"><h3><strong>backspace</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Erase the last digit from the given widget and set focus on it
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The widget (it might be the window itself)
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="command"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>command</strong> (const String& name, Window* wnd = 0)
<br></td><td align="right"><h3><strong>command</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Enqueue an engine.command message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The command line
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="debug"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>debug</strong> (const String& name, bool active, Window* wnd = 0)
<br></td><td align="right"><h3><strong>debug</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Enqueue an engine.debug message.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The debug action content (following the prefix). The format
of this parameter must be 'module:active-true:active-false'.
The line parameter of the message will be filled with 'active-true' if
active is true and with 'active-false' if active is false
</TD></TR>
<TR><TD align="left" valign="top"><i>active</i></TD><TD align="left" valign="top">The widget's state
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="editAccount"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>editAccount</strong> (bool newAcc, NamedList* params, Window* wnd = 0)
<br></td><td align="right"><h3><strong>editAccount</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called when the user wants to add a new account or edit an existing one
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>newAcc</i></TD><TD align="left" valign="top">True to add a new account, false to edit an exisiting one
</TD></TR>
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Initial parameters
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="acceptAccount"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>acceptAccount</strong> (NamedList* params, Window* wnd = 0)
<br></td><td align="right"><h3><strong>acceptAccount</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called when the user wants to save account data
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Initial parameters
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="delAccount"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>delAccount</strong> (const String& account, Window* wnd = 0)
<br></td><td align="right"><h3><strong>delAccount</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called when the user wants to delete an existing account
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>account</i></TD><TD align="left" valign="top">The account's name. Set to empty to delete the current selection
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="updateAccount"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>updateAccount</strong> (const NamedList& account, bool login, bool save)
<br></td><td align="right"><h3><strong>updateAccount</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Add/set an account. Login if required
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>account</i></TD><TD align="left" valign="top">The account's parameters. The name of the list must be the account's name
</TD></TR>
<TR><TD align="left" valign="top"><i>login</i></TD><TD align="left" valign="top">True to login the account
</TD></TR>
<TR><TD align="left" valign="top"><i>save</i></TD><TD align="left" valign="top">True to save the accounts file. If true and file save fails the method will fail
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="loginAccount"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>loginAccount</strong> (const NamedList& account, bool login)
<br></td><td align="right"><h3><strong>loginAccount</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Login/logout an account
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>account</i></TD><TD align="left" valign="top">The account's parameters. The name of the list must be the account's name
</TD></TR>
<TR><TD align="left" valign="top"><i>login</i></TD><TD align="left" valign="top">True to login the account, false to logout
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="updateContact"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>updateContact</strong> (const NamedList& contact, bool save, bool update)
<br></td><td align="right"><h3><strong>updateContact</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Add/set a contact
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>contact</i></TD><TD align="left" valign="top">The contact's parameters. The name of the list must be the contacts's id (name).
If it starts with 'client/' this is a contact updated from server: it can't be changed
</TD></TR>
<TR><TD align="left" valign="top"><i>save</i></TD><TD align="left" valign="top">True to save data to contacts file
</TD></TR>
<TR><TD align="left" valign="top"><i>update</i></TD><TD align="left" valign="top">True to update the interface
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="acceptContact"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>acceptContact</strong> (NamedList* params, Window* wnd = 0)
<br></td><td align="right"><h3><strong>acceptContact</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called when the user wants to save account data
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Initial parameters
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="editContact"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>editContact</strong> (bool newCont, NamedList* params = 0, Window* wnd = 0)
<br></td><td align="right"><h3><strong>editContact</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called when the user wants to add a new contact or edit an existing one
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>newCont</i></TD><TD align="left" valign="top">True to add a new contact, false to edit an existing one
</TD></TR>
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Optional initial parameters
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="delContact"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>delContact</strong> (const String& contact, Window* wnd = 0)
<br></td><td align="right"><h3><strong>delContact</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called when the user wants to delete an existing contact
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>contact</i></TD><TD align="left" valign="top">The contact's id. Set to empty to delete the current selection
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="callContact"></A><A NAME="ref28"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>callContact</strong> (NamedList* params = 0, Window* wnd = 0)
<br></td><td align="right"><h3><strong>callContact</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called when the user wants to call an existing contact
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Optional parameters
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">Optional window containing the widget that triggered the action
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="updateProviders"></A><A NAME="ref29"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>updateProviders</strong> (const NamedList& provider, bool save, bool update)
<br></td><td align="right"><h3><strong>updateProviders</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Add/set account providers data
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>provider</i></TD><TD align="left" valign="top">The provider's parameters. The name of the list must be the provider's id (name)
</TD></TR>
<TR><TD align="left" valign="top"><i>save</i></TD><TD align="left" valign="top">True to save data to providers file
</TD></TR>
<TR><TD align="left" valign="top"><i>update</i></TD><TD align="left" valign="top">True to update the interface
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="callLogUpdate"></A><A NAME="ref30"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>callLogUpdate</strong> (NamedList& params, bool save, bool update)
<br></td><td align="right"><h3><strong>callLogUpdate</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Update the call log history
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Call log data
</TD></TR>
<TR><TD align="left" valign="top"><i>save</i></TD><TD align="left" valign="top">True to save data to history file
</TD></TR>
<TR><TD align="left" valign="top"><i>update</i></TD><TD align="left" valign="top">True to update the interface
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True
</p>
<A NAME="callLogClear"></A><A NAME="ref31"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>callLogClear</strong> (const String& table, const String& direction)
<br></td><td align="right"><h3><strong>callLogClear</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Clear the specified log and the entries from the history file and save the history file
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>table</i></TD><TD align="left" valign="top">Tebale to clear
</TD></TR>
<TR><TD align="left" valign="top"><i>direction</i></TD><TD align="left" valign="top">The call direction to clear (incoming,outgoing).
Note that the direction is the value saved from call.cdr messages.
If empty, all log entries will be cleared
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True
</p>
<A NAME="callLogCall"></A><A NAME="ref32"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>callLogCall</strong> (const String& billid)
<br></td><td align="right"><h3><strong>callLogCall</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Make an outgoing call to a target picked from the call log
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>billid</i></TD><TD align="left" valign="top">The bill id of the call
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success (call initiated)
</p>
<A NAME="callLogCreateContact"></A><A NAME="ref33"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>callLogCreateContact</strong> (const String& billid)
<br></td><td align="right"><h3><strong>callLogCreateContact</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Create a contact from a call log entry
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>billid</i></TD><TD align="left" valign="top">The bill id of the call
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success (address book popup window was displayed)
</p>
<A NAME="help"></A><A NAME="ref34"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>help</strong> (const String& action, Window* wnd)
<br></td><td align="right"><h3><strong>help</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process help related actions
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>action</i></TD><TD align="left" valign="top">The action's name
</TD></TR>
<TR><TD align="left" valign="top"><i>wnd</i></TD><TD align="left" valign="top">The window owning the control
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="calltoLoaded"></A><A NAME="ref35"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>calltoLoaded</strong> ()
<br></td><td align="right"><h3><strong>calltoLoaded</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called by the client after loaded the callto history file
</p>
<p><b>Returns</b>: True to tell the client to stop notifying other logics
</p>
<A NAME="loadedWindows"></A><A NAME="ref36"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>loadedWindows</strong> ()
<br></td><td align="right"><h3><strong>loadedWindows</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called by the client after loaded the windows
</p>
<A NAME="initializedWindows"></A><A NAME="ref37"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>initializedWindows</strong> ()
<br></td><td align="right"><h3><strong>initializedWindows</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called by the client after loaded and intialized the windows
</p>
<A NAME="initializedClient"></A><A NAME="ref38"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>initializedClient</strong> ()
<br></td><td align="right"><h3><strong>initializedClient</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called by the client after loaded and intialized the windows and
loaded configuration files.
The default logic update client settings
</p>
<p><b>Returns</b>: True to stop processing this notification
</p>
<A NAME="exitingClient"></A><A NAME="ref39"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>exitingClient</strong> ()
<br></td><td align="right"><h3><strong>exitingClient</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Called by the client before exiting.
The default logic save client settings
</p>
<A NAME="handleUiAction"></A><A NAME="ref40"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>handleUiAction</strong> (Message& msg, bool& stopLogic)
<br></td><td align="right"><h3><strong>handleUiAction</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process ui.action message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Received message
</TD></TR>
<TR><TD align="left" valign="top"><i>stopLogic</i></TD><TD align="left" valign="top">Set to true on exit to tell the client to stop asking other logics
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop further processing by the engine
</p>
<A NAME="handleCallCdr"></A><A NAME="ref41"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>handleCallCdr</strong> (Message& msg, bool& stopLogic)
<br></td><td align="right"><h3><strong>handleCallCdr</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process call.cdr message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Received message
</TD></TR>
<TR><TD align="left" valign="top"><i>stopLogic</i></TD><TD align="left" valign="top">Set to true on exit to tell the client to stop asking other logics
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop further processing by the engine
</p>
<A NAME="handleUserLogin"></A><A NAME="ref42"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>handleUserLogin</strong> (Message& msg, bool& stopLogic)
<br></td><td align="right"><h3><strong>handleUserLogin</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process user.login message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Received message
</TD></TR>
<TR><TD align="left" valign="top"><i>stopLogic</i></TD><TD align="left" valign="top">Set to true on exit to tell the client to stop asking other logics
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop further processing by the engine
</p>
<A NAME="handleUserNotify"></A><A NAME="ref43"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>handleUserNotify</strong> (Message& msg, bool& stopLogic)
<br></td><td align="right"><h3><strong>handleUserNotify</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process user.notify message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Received message
</TD></TR>
<TR><TD align="left" valign="top"><i>stopLogic</i></TD><TD align="left" valign="top">Set to true on exit to tell the client to stop asking other logics
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop further processing by the engine
</p>
<A NAME="handleResourceNotify"></A><A NAME="ref44"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>handleResourceNotify</strong> (Message& msg, bool& stopLogic)
<br></td><td align="right"><h3><strong>handleResourceNotify</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process resource.notify message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Received message
</TD></TR>
<TR><TD align="left" valign="top"><i>stopLogic</i></TD><TD align="left" valign="top">Set to true on exit to tell the client to stop asking other logics
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop further processing by the engine
</p>
<A NAME="handleResourceSubscribe"></A><A NAME="ref45"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>handleResourceSubscribe</strong> (Message& msg, bool& stopLogic)
<br></td><td align="right"><h3><strong>handleResourceSubscribe</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process resource.subscribe message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Received message
</TD></TR>
<TR><TD align="left" valign="top"><i>stopLogic</i></TD><TD align="left" valign="top">Set to true on exit to tell the client to stop asking other logics
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop further processing by the engine
</p>
<A NAME="handleClientChanUpdate"></A><A NAME="ref46"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>handleClientChanUpdate</strong> (Message& msg, bool& stopLogic)
<br></td><td align="right"><h3><strong>handleClientChanUpdate</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process clientchan.update message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Received message
</TD></TR>
<TR><TD align="left" valign="top"><i>stopLogic</i></TD><TD align="left" valign="top">Set to true on exit to tell the client to stop asking other logics
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop further processing by the engine
</p>
<A NAME="defaultMsgHandler"></A><A NAME="ref47"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>defaultMsgHandler</strong> (Message& msg, int id, bool& stopLogic)
<br></td><td align="right"><h3><strong>defaultMsgHandler</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Default message processor called for id's not defined in client.
Descendants may override it to process custom messages installed by
them and relayed through the client
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Received message
</TD></TR>
<TR><TD align="left" valign="top"><i>id</i></TD><TD align="left" valign="top">Message id
</TD></TR>
<TR><TD align="left" valign="top"><i>stopLogic</i></TD><TD align="left" valign="top">Set to true on exit to tell the client to stop asking other logics
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop further processing by the engine
</p>
<A NAME="engineStart"></A><A NAME="ref48"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>engineStart</strong> (Message& msg)
<br></td><td align="right"><h3><strong>engineStart</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Engine start notification
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">The engine.start message
</TD></TR>
</TABLE></P>
<A NAME="addDurationUpdate"></A><A NAME="ref49"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>addDurationUpdate</strong> (DurationUpdate* duration, bool autoDelete = false)
<br></td><td align="right"><h3><strong>addDurationUpdate</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Add a duration object to this client's list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>duration</i></TD><TD align="left" valign="top">The object to add
</TD></TR>
<TR><TD align="left" valign="top"><i>autoDelete</i></TD><TD align="left" valign="top">True to delete the object when the list is cleared
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="removeDurationUpdate"></A><A NAME="ref50"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>removeDurationUpdate</strong> (const String& name, bool delObj = false)
<br></td><td align="right"><h3><strong>removeDurationUpdate</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Remove a duration object from list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The name of the object to remove
</TD></TR>
<TR><TD align="left" valign="top"><i>delObj</i></TD><TD align="left" valign="top">True to destroy the object, false to remove it
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="removeDurationUpdate"></A><A NAME="ref51"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>removeDurationUpdate</strong> (DurationUpdate* duration, bool delObj = false)
<br></td><td align="right"><h3><strong>removeDurationUpdate</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Remove a duration object from list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>duration</i></TD><TD align="left" valign="top">The object to remove
</TD></TR>
<TR><TD align="left" valign="top"><i>delObj</i></TD><TD align="left" valign="top">True to destroy the object, false to remove it
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="findDurationUpdate"></A><A NAME="ref52"></A><table width="100%"><tr bgcolor="#eeeeee"><td> DurationUpdate* <strong>findDurationUpdate</strong> (const String& name, bool ref = true)
<br></td><td align="right"><h3><strong>findDurationUpdate</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Find a duration update by its name
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The name of the object to find
</TD></TR>
<TR><TD align="left" valign="top"><i>ref</i></TD><TD align="left" valign="top">True to increase its reference counter before returning
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: DurationUpdate pointer or 0
</p>
<A NAME="clearDurationUpdate"></A><A NAME="ref53"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>clearDurationUpdate</strong> ()
<br></td><td align="right"><h3><strong>clearDurationUpdate</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Remove all duration objects
</p>
<A NAME="destruct"></A><A NAME="ref54"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>destruct</strong> ()
<br></td><td align="right"><h3><strong>destruct</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Release memory. Remove from client's list
</p>
<p>Reimplemented from <A HREF="TelEngine__GenObject.html#destruct">GenObject</A>.</p>
<A NAME="initStaticData"></A><A NAME="ref55"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>initStaticData</strong> ()
<br></td><td align="right"><h3><strong>initStaticData</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Init static logic lists.
Called by the client when start running
</p>
<A NAME="s_accOptions"></A><A NAME="ref56"></A><table width="100%"><tr bgcolor="#eeeeee"><td>static ObjList <strong>s_accOptions</strong>
</td><td align="right"><h3><strong>s_accOptions</strong></h3></td></tr></table><p></p><A NAME="s_provParams[]"></A><A NAME="ref57"></A><table width="100%"><tr bgcolor="#eeeeee"><td>static const char* <strong>s_provParams[]</strong>
</td><td align="right"><h3><strong>s_provParams[]</strong></h3></td></tr></table><p></p><A NAME="ClientLogic"></A><A NAME="ref58"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>ClientLogic</strong> (const char* name, int priority)
<br></td><td align="right"><h3><strong>ClientLogic</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Constructor. Append itself to the client's list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">The name of this logic (module)
</TD></TR>
<TR><TD align="left" valign="top"><i>priority</i></TD><TD align="left" valign="top">The priority of this logic
</TD></TR>
</TABLE></P>
<A NAME="idleTimerTick"></A><A NAME="ref59"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>idleTimerTick</strong> (Time& time)
<br></td><td align="right"><h3><strong>idleTimerTick</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Method called by the client when idle.
This method is called in the UI's thread
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>time</i></TD><TD align="left" valign="top">The current time
</TD></TR>
</TABLE></P>
<A NAME="s_protocols"></A><A NAME="ref60"></A><table width="100%"><tr bgcolor="#eeeeee"><td>static ObjList <strong>s_protocols</strong>
</td><td align="right"><h3><strong>s_protocols</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="s_protocolsMutex"></A><A NAME="ref61"></A><table width="100%"><tr bgcolor="#eeeeee"><td>static Mutex <strong>s_protocolsMutex</strong>
</td><td align="right"><h3><strong>s_protocolsMutex</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_durationUpdate"></A><A NAME="ref62"></A><table width="100%"><tr bgcolor="#eeeeee"><td>ObjList <strong>m_durationUpdate</strong>
</td><td align="right"><h3><strong>m_durationUpdate</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_durationMutex"></A><A NAME="ref63"></A><table width="100%"><tr bgcolor="#eeeeee"><td>Mutex <strong>m_durationMutex</strong>
</td><td align="right"><h3><strong>m_durationMutex</strong></h3></td></tr></table><p> <small>[protected]</small></p><HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|