PageRenderTime 30ms CodeModel.GetById 21ms app.highlight 6ms RepoModel.GetById 1ms app.codeStats 0ms

/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/RTPPkg/RTPPlStats.java

http://mobicents.googlecode.com/
Java | 82 lines | 30 code | 10 blank | 42 comment | 0 complexity | 177e676f0ddbb4d39c9f5c25f1bf4a33 MD5 | raw file
 1package javax.megaco.pkg.RTPPkg;
 2
 3import javax.megaco.pkg.MegacoPkg;
 4import javax.megaco.pkg.PkgConsts;
 5import javax.megaco.pkg.PkgStatsItem;
 6
 7/**
 8 * 
 9 * The MEGACO Packet Loss statistics class extends the PkgStatsItem class. This
10 * is a final class. This class defines Packet Loss statistics of MEGACO RTP
11 * package. The methods shall define that this statistics item belongs to the
12 * RTP package.
13 */
14public final class RTPPlStats extends PkgStatsItem {
15
16	/**
17	 * Identifies Packet loss statistics of the MEGACO RTP Package. Its value
18	 * shall be set equal to 0x0006.
19	 */
20	public static final int RTP_PL_STATS = 0x0006;
21
22	/**
23	 * Constructs a Jain MEGACO Object representing statistics item of the
24	 * MEGACO Package for statistics Packet Loss and Package as RTP.
25	 */
26	public RTPPlStats() {
27		super();
28		super.statisticsId = RTP_PL_STATS;
29		super.itemId = RTP_PL_STATS;
30		super.packageId = new RTPPkg();
31	}
32
33	/**
34	 * This method is used to get the item identifier from an Item object. The
35	 * implementations of this method in this class returns the id of the Packet
36	 * Loss statistics of RTP Package.
37	 * 
38	 * @return It shall return {@link RTP_PL_STATS}.
39	 */
40	public int getItemId() {
41		return super.itemId;
42	}
43
44	/**
45	 * This method gets the package id to which the item belongs. Since the
46	 * Packet Loss statistics is defined in the RTP Package of MEGACO protocol,
47	 * this method returns the value {@link PkgConsts.RTP_PACKAGE} constant.
48	 * This constant is defined in the PkgConsts class.
49	 * 
50	 * 
51	 * 
52	 * @return The package id RTP_PACKAGE.
53	 */
54	public MegacoPkg getItemsPkgId() {
55		return super.packageId;
56	}
57
58	/**
59	 * This method is used to get the statistics identifier from an Statistics
60	 * Item object. The implementations of this method in this class returns the
61	 * id of the Packet Loss statistics of RTP Package.
62	 * 
63	 * @return It shall return {@link RTP_PL_STATS}.
64	 */
65	public int getStatisticsId() {
66		return super.statisticsId;
67	}
68
69	// FIXME; ??
70	@Override
71	public int getItemValueType() {
72		// TODO Auto-generated method stub
73		return 0;
74	}
75
76	@Override
77	public int[] getItemsDescriptorIds() {
78		// TODO Auto-generated method stub
79		return null;
80	}
81
82}