Package net.sf.fsp.fsplib

Class FSPpacket

  • All Implemented Interfaces:
    
public class FSPpacket

    This class handles assembly and disassembly FSP packets from/to DatagramPacket.

    FSPpacket class represents one packet sent over network while carrying payload of FSP protocol.

    Since:

    1.0

    Author:

    Radim Kolar

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description
      FSPpacket() Constructs a new storage for handling client side of FSP packets.
      FSPpacket(boolean serverside) Constructs a new storage for handling FSP packets.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      boolean disassemble(DatagramPacket udp) Disassemble UDP packet into this FSP packet.
      DatagramPacket assemble(DatagramPacket udp) Generate UDP packet from this FSP packet.
      String toString() prints header of FSP packet.
      void setData(Array<byte> data1, int offset1, int length1, Array<byte> data2, int offset2, int length2) set FSP data payload to data1 and data2
      boolean isServerSide() check if we are using server side checksum method.
      void expect(byte command) Test if packet is expected response to sent command.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • FSPpacket

        FSPpacket()

        Constructs a new storage for handling client side of FSP packets. Storage can be used for sending any number of packets.

      • FSPpacket

        FSPpacket(boolean serverside)

        Constructs a new storage for handling FSP packets. Storage can be used for sending any number of packets.

        Parameters:
        serverside - Use server-side checksum method for FSP packets

    • Method Detail

      • disassemble

         boolean disassemble(DatagramPacket udp)

        Disassemble UDP packet into this FSP packet.

        Parameters:
        udp - the DatagramPacket to be disassembled.
        Returns:

        true if valid FSP packet was found

        Since:

        1.0

      • assemble

         DatagramPacket assemble(DatagramPacket udp)

        Generate UDP packet from this FSP packet.

        Parameters:
        udp - storage for assembled packet
        Returns:

        assembled packet. Reference to udp paramater.

        Since:

        1.0

      • toString

         String toString()

        prints header of FSP packet.

        Returns:

        FSP Header converted to the string

        Since:

        1.0

      • setData

         void setData(Array<byte> data1, int offset1, int length1, Array<byte> data2, int offset2, int length2)

        set FSP data payload to data1 and data2

        Parameters:
        data1 - data payload array
        offset1 - starting offset of data in data1 array
        length1 - data size
        data2 - xtra data payload array
        offset2 - starting offset of xtra data in data2 array
        length2 - xtra data size
        Since:

        1.0

      • isServerSide

         boolean isServerSide()

        check if we are using server side checksum method.

        Returns:

        true if packet is from server to client.

        Since:

        1.0rc7

      • expect

         void expect(byte command)

        Test if packet is expected response to sent command. If comparison fails, throw exception. If packet contains CC_ERR, use it for detailed error message.

        Parameters:
        command - expected reply
        Since:

        1.0rc7