blob: 6ab0254bdb36c9ed5844c0e204f7029abfb2a8d9 [file] [log] [blame]
Yotam Harcholf3f11152013-09-05 16:47:16 -07001package org.projectfloodlight.openflow.types;
2
3import org.jboss.netty.buffer.ChannelBuffer;
4import org.projectfloodlight.openflow.exceptions.OFParseError;
5
Andreas Wundsam22ba3af2013-10-04 16:00:30 -07006import com.google.common.hash.PrimitiveSink;
Andreas Wundsam85c961f2013-09-29 21:22:12 -07007import com.google.common.primitives.Ints;
8
Yotam Harcholf3f11152013-09-05 16:47:16 -07009/**
10 * Represents L4 (Transport Layer) port (TCP, UDP, etc.)
11 *
12 * @author Yotam Harchol (yotam.harchol@bigswitch.com)
13 */
14public class TransportPort implements OFValueType<TransportPort> {
15
16 static final int LENGTH = 2;
17 static final int MAX_PORT = 0xFFFF;
18 static final int MIN_PORT = 0;
19
Andreas Wundsamb75c4ad2013-09-23 14:45:35 -070020 private final static int NONE_VAL = 0;
21 public final static TransportPort NONE = new TransportPort(NONE_VAL);
22
Yotam Harcholf3f11152013-09-05 16:47:16 -070023 public static final TransportPort NO_MASK = new TransportPort(0xFFFFFFFF);
24 public static final TransportPort FULL_MASK = TransportPort.of(0x0);
25
26 private final int port;
27
28 private TransportPort(int port) {
29 this.port = port;
30 }
31
32 public static TransportPort of(int port) {
Andreas Wundsamb75c4ad2013-09-23 14:45:35 -070033 if(port == NONE_VAL)
34 return NONE;
KC Wang6a554c72014-05-12 12:03:35 -070035 else if (port == NO_MASK.port)
KC Wang31698992014-05-12 18:57:38 -070036 return NO_MASK;
Andreas Wundsamb75c4ad2013-09-23 14:45:35 -070037 else if (port < MIN_PORT || port > MAX_PORT) {
Yotam Harcholf3f11152013-09-05 16:47:16 -070038 throw new IllegalArgumentException("Illegal transport layer port number: " + port);
39 }
40 return new TransportPort(port);
41 }
42
43 @Override
44 public int getLength() {
45 return LENGTH;
46 }
47
48 public int getPort() {
49 return port;
50 }
51
52 @Override
53 public boolean equals(Object obj) {
54 if (!(obj instanceof TransportPort))
55 return false;
56 TransportPort other = (TransportPort)obj;
57 if (other.port != this.port)
58 return false;
59 return true;
60 }
61
62 @Override
63 public int hashCode() {
64 final int prime = 59;
65 int result = 1;
66 result = prime * result + port;
67 return result;
68 }
69
70 @Override
71 public String toString() {
72 return Integer.toString(port);
73 }
74
75 public void write2Bytes(ChannelBuffer c) {
76 c.writeShort(this.port);
77 }
78
79 public static TransportPort read2Bytes(ChannelBuffer c) throws OFParseError {
80 return TransportPort.of((c.readUnsignedShort() & 0x0FFFF));
81 }
82
83 @Override
84 public TransportPort applyMask(TransportPort mask) {
85 return TransportPort.of(this.port & mask.port);
86 }
87
Andreas Wundsam85c961f2013-09-29 21:22:12 -070088 @Override
89 public int compareTo(TransportPort o) {
90 return Ints.compare(port, o.port);
91 }
92
Andreas Wundsam22ba3af2013-10-04 16:00:30 -070093 @Override
94 public void putTo(PrimitiveSink sink) {
95 sink.putShort((short) port);
96 }
97
Yotam Harcholf3f11152013-09-05 16:47:16 -070098}