X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fsal%2Fapi%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fpacket%2FPacket.java;h=58b5d3914aa2dc199111dd2f2dc1ff8d5289dcc0;hp=b19c0f862b9e559219d5a00e8a3d289122a6c1a8;hb=50d50e106bcbe761b05417e747c217c1f5b36534;hpb=ee36e17cd29fd1b5ebdf895a6deb14c4e1d8c9e2 diff --git a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/packet/Packet.java b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/packet/Packet.java index b19c0f862b..58b5d3914a 100644 --- a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/packet/Packet.java +++ b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/packet/Packet.java @@ -77,7 +77,7 @@ public abstract class Packet { /** * This method deserializes the data bits obtained from the wire into the * respective header and payload which are of type Packet - * + * * @param byte[] data - data from wire to deserialize * @param int bitOffset bit position where packet header starts in data * array @@ -151,7 +151,7 @@ public abstract class Packet { /** * This method serializes the header and payload from the respective * packet class, into a single stream of bytes to be sent on the wire - * + * * @return The byte array representing the serialized Packet * @throws PacketException */ @@ -206,7 +206,7 @@ public abstract class Packet { * byte stream which cannot be done or cannot be done efficiently during the * normal Packet.serialize() path. An example is the checksum computation * for IPv4 - * + * * @param byte[] - serialized bytes * @throws PacketException */ @@ -221,7 +221,7 @@ public abstract class Packet { * of checksum varies based on the protocol, this method is overridden. * Currently only IPv4 and ICMP do checksum computation and validation. TCP * and UDP need to implement these if required. - * + * * @param byte[] data The byte stream representing the Ethernet frame * @param int startBitOffset The bit offset from where the byte array corresponding to this Packet starts in the frame * @throws PacketException @@ -233,7 +233,7 @@ public abstract class Packet { /** * Gets the header length in bits - * + * * @return int the header length in bits */ public int getHeaderSize() { @@ -256,7 +256,7 @@ public abstract class Packet { * This method fetches the start bit offset for header field specified by * 'fieldname'. The offset is present in the hdrFieldCoordMap of the * respective packet class - * + * * @param String * fieldName * @return Integer - startOffset of the requested field @@ -269,7 +269,7 @@ public abstract class Packet { * This method fetches the number of bits for header field specified by * 'fieldname'. The numBits are present in the hdrFieldCoordMap of the * respective packet class - * + * * @param String * fieldName * @return Integer - number of bits of the requested field @@ -297,7 +297,7 @@ public abstract class Packet { /** * Returns the raw payload carried by this packet in case payload was not * parsed. Caller can call this function in case the getPaylod() returns null. - * + * * @return The raw payload if not parsable as an array of bytes, null otherwise */ public byte[] getRawPayload() { @@ -306,7 +306,7 @@ public abstract class Packet { /** * Set a raw payload in the packet class - * + * * @param payload The raw payload as byte array */ public void setRawPayload(byte[] payload) { @@ -319,8 +319,8 @@ public abstract class Packet { * packet received from wire is not equal to the checksum read from the * stream. For the Packet class which do not have a checksum field, this * function will always return false. - * - * + * + * * @return true if the deserialized packet's recomputed checksum is not * equal to the packet carried checksum */