Java Doc for CometNotifier.java in  » Ajax » ItsNat » org » itsnat » core » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Ajax » ItsNat » org.itsnat.core 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.itsnat.core.CometNotifier

All known Subclasses:   org.itsnat.impl.core.comet.CometNotifierImpl,
CometNotifier
public interface CometNotifier (Code)
Is used to implement the Comet or server push technique to notify the client to be updated usually when the document is changed.

The ItsNat Comet approach is based on AJAX, the client is ever waiting for an AJAX asynchronous event to return. When new code must be sent to the client this event returns and updates the client and automatically a new AJAX asynchronous request is sent to the server waiting to new asynchronous server changes (technique sometimes called as "long polling").

Use COMET if you have to monitor by web a never ending server process.

Current implementation does not need a special server but it locks a thread per client (and a HTTP connection per client). This thread is stalled most of the time, the scalability issue is more related to the maximun number of threads the system can manage.


See Also:   ClientDocument.createCometNotifier
See Also:   ItsNatDocument.addAsynchronousTask(Runnableboolean)
author:
   Jose Maria Arranz Santamaria




Method Summary
public  longgetAJAXTimeout()
     Returns the default timeout of COMET AJAX events.
public  longgetExpirationDelay()
     Returns the maximum expiration delay.
public  ItsNatDocumentgetItsNatDocument()
     Returns the asociated document.
public  booleanisStopped()
     Informs whether this notifier is stopped.
public  voidnotifyClient()
     Notifies the client thread to send pending document modifications.
public  voidsetExpirationDelay(long expirationDelay)
     Sets the maximum expiration delay.
public  voidstop()
     Stops and disposes this notifier.



Method Detail
getAJAXTimeout
public long getAJAXTimeout()(Code)
Returns the default timeout of COMET AJAX events.

This is the maximum time a stalled COMET AJAX request will wait to receive a notification, if this limit is reached the last request is aborted stopping the COMET process. If a timeout is defined this value should be greater than CometNotifier.getExpirationDelay() .

COMET AJAX events are ever asynchronous.

the timeout of COMET AJAX events in miliseconds.



getExpirationDelay
public long getExpirationDelay()(Code)
Returns the maximum expiration delay. This is the maximum time a stalled client thread will wait to receive a notification, if this limit is reached this notifier is automatically stopped.

This limit is defined to avoid an unlimited wait because the notifier process has ended and the notifier was not explicitly stopped.

the maximum expiration delay in milliseconds. By default is 1 hour.
See Also:   CometNotifier.setExpirationDelay(long)



getItsNatDocument
public ItsNatDocument getItsNatDocument()(Code)
Returns the asociated document. the document object this Comet notifier is bound to.



isStopped
public boolean isStopped()(Code)
Informs whether this notifier is stopped. A Comet notifier is stopped if it was explicitly stopped calling CometNotifier.stop() or the associated document was destroyed. true if this notifier is stopped.



notifyClient
public void notifyClient()(Code)
Notifies the client thread to send pending document modifications.

This method may be called by a non-servlet based thread, and no synchronization of the ItsNatDocument is necessary.

The client thread is woke up to send document modifications and a new AJAX request is sent to wait again.




setExpirationDelay
public void setExpirationDelay(long expirationDelay)(Code)
Sets the maximum expiration delay.
Parameters:
  expirationDelay - the maximum expiration delay in milliseconds.
See Also:   CometNotifier.getExpirationDelay()



stop
public void stop()(Code)
Stops and disposes this notifier. The stalled client thread is woke up to send any pending modification and no new request is sent.

A stopped Comet notifier is invalid and cannot be reused.




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.