FSPpacket (FSP Java Library 1.0.0-RC11 API)

java.lang.Object
- net.sf.fsp.fsplib.FSPpacket

```
public class FSPpacket
extends Object
```
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

Version:

1.0rc7

Author:

Radim Kolar

See Also:

DatagramPacket

Field Summary

Fields
Modifier and Type	Field and Description
`short`	`bb_key` server access KEY, needs to be correct
`short`	`bb_len` number of required bytes in buffer
`int`	`bb_pos` file position pointer (4GB-1 max)
`short`	`bb_seq` client side sequence number, any number can be used
`byte[]`	`buf` buffer for holding user generated data to be transmitted via FSP protocol
`static byte`	`CC_BYE` finish a session
`static byte`	`CC_DEL_DIR` delete directory
`static byte`	`CC_DEL_FILE` delete file
`static byte`	`CC_ERR` error response from server
`static byte`	`CC_GET_DIR` get a directory listing
`static byte`	`CC_GET_FILE` get a file
`static byte`	`CC_GET_PRO` get directory protection
`static byte`	`CC_GRAB_DONE` atomic get+delete done
`static byte`	`CC_GRAB_FILE` atomic get+delete
`static byte`	`CC_INFO` get server info block
`static byte`	`CC_INSTALL` close a opened file for writing and move it to final location
`static byte`	`CC_LIMIT` commands greater then 0x7f are reserved for FSP v3 headers
`static byte`	`CC_MAKE_DIR` make directory
`static byte`	`CC_RENAME` rename file or directory
`static byte`	`CC_SET_PRO` set directory protection
`static byte`	`CC_STAT` get file/directory information
`static byte`	`CC_TEST` reserved for testing FSP v3 header
`static byte`	`CC_UP_LOAD` open temporary file for writing
`static byte`	`CC_VERSION` get server setup
`byte`	`cmd` FSP command, use one of CC_ constants
`static int`	`HSIZE` Size of FSP protocol v2 header - 12 bytes.
`static int`	`MAXSIZE` Maximum packet size (HSIZE+MAXSPACE).
`static int`	`MAXSPACE` Maximum payload supported by this library.
`protected boolean`	`serverside`
`static int`	`SPACE` Maximum standard FSP data payload - 1024 bytes.
`byte`	`sum` FSP packet checksum, field is computed by assemble()
`int`	`xtra_len` optional data size in buffer

Constructor Summary

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

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - HSIZE
```
public static final int HSIZE
```
    Size of FSP protocol v2 header - 12 bytes.
    
    See Also:
    
    Constant Field Values
  - SPACE
```
public static final int SPACE
```
    Maximum standard FSP data payload - 1024 bytes. All FSP clients and servers are required to handle this.
    
    See Also:
    
    Constant Field Values
  - MAXSPACE
```
public static final int MAXSPACE
```
    Maximum payload supported by this library.
    
    See Also:
    
    Constant Field Values
  - MAXSIZE
```
public static final int MAXSIZE
```
    Maximum packet size (HSIZE+MAXSPACE).
    
    See Also:
    
    Constant Field Values
  - serverside
```
protected boolean serverside
```
  - cmd
```
public byte cmd
```
    FSP command, use one of CC_ constants
  - sum
```
public byte sum
```
    FSP packet checksum, field is computed by assemble()
  - bb_key
```
public short bb_key
```
    server access KEY, needs to be correct
  - bb_seq
```
public short bb_seq
```
    client side sequence number, any number can be used
  - bb_len
```
public short bb_len
```
    number of required bytes in buffer
  - bb_pos
```
public int bb_pos
```
    file position pointer (4GB-1 max)
  - xtra_len
```
public int xtra_len
```
    optional data size in buffer
  - buf
```
public byte[] buf
```
    buffer for holding user generated data to be transmitted via FSP protocol
  - CC_VERSION
```
public static final byte CC_VERSION
```
    get server setup
    
    See Also:
    
    Constant Field Values
  - CC_INFO
```
public static final byte CC_INFO
```
    get server info block
    
    See Also:
    
    Constant Field Values
  - CC_ERR
```
public static final byte CC_ERR
```
    error response from server
    
    See Also:
    
    Constant Field Values
  - CC_GET_DIR
```
public static final byte CC_GET_DIR
```
    get a directory listing
    
    See Also:
    
    Constant Field Values
  - CC_GET_FILE
```
public static final byte CC_GET_FILE
```
    get a file
    
    See Also:
    
    Constant Field Values
  - CC_UP_LOAD
```
public static final byte CC_UP_LOAD
```
    open temporary file for writing
    
    See Also:
    
    Constant Field Values
  - CC_INSTALL
```
public static final byte CC_INSTALL
```
    close a opened file for writing and move it to final location
    
    See Also:
    
    Constant Field Values
  - CC_DEL_FILE
```
public static final byte CC_DEL_FILE
```
    delete file
    
    See Also:
    
    Constant Field Values
  - CC_DEL_DIR
```
public static final byte CC_DEL_DIR
```
    delete directory
    
    See Also:
    
    Constant Field Values
  - CC_GET_PRO
```
public static final byte CC_GET_PRO
```
    get directory protection
    
    See Also:
    
    Constant Field Values
  - CC_SET_PRO
```
public static final byte CC_SET_PRO
```
    set directory protection
    
    See Also:
    
    Constant Field Values
  - CC_MAKE_DIR
```
public static final byte CC_MAKE_DIR
```
    make directory
    
    See Also:
    
    Constant Field Values
  - CC_BYE
```
public static final byte CC_BYE
```
    finish a session
    
    See Also:
    
    Constant Field Values
  - CC_GRAB_FILE
```
public static final byte CC_GRAB_FILE
```
    atomic get+delete
    
    See Also:
    
    Constant Field Values
  - CC_GRAB_DONE
```
public static final byte CC_GRAB_DONE
```
    atomic get+delete done
    
    See Also:
    
    Constant Field Values
  - CC_STAT
```
public static final byte CC_STAT
```
    get file/directory information
    
    See Also:
    
    Constant Field Values
  - CC_RENAME
```
public static final byte CC_RENAME
```
    rename file or directory
    
    See Also:
    
    Constant Field Values
  - CC_LIMIT
```
public static final byte CC_LIMIT
```
    commands greater then 0x7f are reserved for FSP v3 headers
    
    See Also:
    
    Constant Field Values
  - CC_TEST
```
public static final byte CC_TEST
```
    reserved for testing FSP v3 header
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FSPpacket
```
public FSPpacket()
```
    Constructs a new storage for handling client side of FSP packets. Storage can be used for sending any number of packets.
    
    Since:
    
    1.0
  - FSPpacket
```
public 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
    
    Since:
    
    1.0rc4
- Method Detail
  - disassemble
```
public 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
```
public 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
```
public String toString()
```
    prints header of FSP packet.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    FSP Header converted to the string
    
    Since:
    
    1.0
  - setData
```
public void setData(byte[] data1,
                    int offset1,
                    int length1,
                    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
    
    Throws:
    
    IllegalArgumentException - If data can't fit into packet, have invalid offsets or negative length
    
    Since:
    
    1.0
  - isServerSide
```
public boolean isServerSide()
```
    check if we are using server side checksum method.
    
    Returns:
    
    true if packet is from server to client.
    
    Since:
    
    1.0rc7
  - expect
```
public void expect(byte command)
            throws IOException
```
    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
    
    Throws:
    
    IOException - unexpected response received
    
    Since:
    
    1.0rc7

Class FSPpacket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HSIZE

SPACE

MAXSPACE

MAXSIZE

serverside

cmd

sum

bb_key

bb_seq

bb_len

bb_pos

xtra_len

buf

CC_VERSION

CC_INFO

CC_ERR

CC_GET_DIR

CC_GET_FILE

CC_UP_LOAD

CC_INSTALL

CC_DEL_FILE

CC_DEL_DIR

CC_GET_PRO

CC_SET_PRO

CC_MAKE_DIR

CC_BYE

CC_GRAB_FILE

CC_GRAB_DONE

CC_STAT

CC_RENAME

CC_LIMIT

CC_TEST

Constructor Detail

FSPpacket

FSPpacket

Method Detail

disassemble

assemble

toString

setData

isServerSide

expect