Java Doc for MaxForwardsHeader.java in  » 6.0-JDK-Modules » Java-Advanced-Imaging » javax » sip » header » 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 » 6.0 JDK Modules » Java Advanced Imaging » javax.sip.header 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.sip.header.MaxForwardsHeader

MaxForwardsHeader
public interface MaxForwardsHeader extends Header(Code)
The Max-Forwards header field must be used with any SIP method to limit the number of proxies or gateways that can forward the request to the next downstream server. This can also be useful when the client is attempting to trace a request chain that appears to be failing or looping in mid-chain.

The Max-Forwards value is an integer in the range 0-255 indicating the remaining number of times this request message is allowed to be forwarded. This count is decremented by each server that forwards the request. The recommended initial value is 70.

This header field should be inserted by elements that can not otherwise guarantee loop detection. For example, a B2BUA should insert a Max-Forwards header field.

For Example:
Max-Forwards: 6
author:
   BEA Systems, NIST
version:
   1.2



Field Summary
final public static  StringNAME
    


Method Summary
public  voiddecrementMaxForwards()
     This convenience function decrements the number of max-forwards by one. This utility is useful for proxy functionality.
throws:
  TooManyHopsException - if implementation cannot decrementmax-fowards i.e.
public  booleanequals(Object obj)
     Compare this MaxForwardsHeader for equality with another.
public  intgetMaxForwards()
     Gets the maximum number of forwards value of this MaxForwardsHeader.
public  voidsetMaxForwards(int maxForwards)
     Sets the max-forwards argument of this MaxForwardsHeader to the supplied maxForwards value.

Field Detail
NAME
final public static String NAME(Code)
Name of MaxForwardsHeader





Method Detail
decrementMaxForwards
public void decrementMaxForwards() throws TooManyHopsException(Code)
This convenience function decrements the number of max-forwards by one. This utility is useful for proxy functionality.
throws:
  TooManyHopsException - if implementation cannot decrementmax-fowards i.e. max-forwards has reached zero



equals
public boolean equals(Object obj)(Code)
Compare this MaxForwardsHeader for equality with another. This method overrides the equals method in javax.sip.Header. This method specifies object equality as outlined by RFC3261. Two MaxForwards header fields are equivalent if their max forwards integer match.
Parameters:
  obj - the object to compare this MaxForwardsHeader with. true if obj is an instance of this classrepresenting the same MaxForwardsHeader as this, false otherwise.
since:
   v1.2



getMaxForwards
public int getMaxForwards()(Code)
Gets the maximum number of forwards value of this MaxForwardsHeader. the maximum number of forwards of this MaxForwardsHeader



setMaxForwards
public void setMaxForwards(int maxForwards) throws InvalidArgumentException(Code)
Sets the max-forwards argument of this MaxForwardsHeader to the supplied maxForwards value.
Parameters:
  maxForwards - - the number of max-forwards
throws:
  InvalidArgumentException - if the maxForwards argument is lessthan 0 or greater than 255.



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