stella.net.ads.protocol

Class AdsCommand

java.lang.Object

stella.net.ads.protocol.AdsCommand

Direct Known Subclasses:

ControlAds, DeviceInfoAds, IndexAds, StateAds

public abstract class AdsCommand
extends Object

An ADS command symbolizes a communication that consists of sending a package and parsing the answer package.

Author:

wooz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdsCommand.Cmd

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMANDREQUEST
private int	idxcmd
static int	RESERVED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AdsCommand(int commandid)

Method Summary

Modifier and Type	Method and Description
int	getFlag()
abstract long	getPayloadLength() Returns the length of the payload for the command to send.
abstract AdsPayload	parse(ByteBuffer full, AdsHeader h) Parses the reply payload.
AdsHeader	prepareHeader(AdsSocketChannel io, int id) Prepares the header from static information in the ads socket channel, our command code and the cycle id
abstract AdsPayload	preparePayload(AdsSocketChannel io, AdsHeader h) Prepares the payload.

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED

public static final int RESERVED

See Also:

Constant Field Values

COMMANDREQUEST

public static final int COMMANDREQUEST

See Also:

Constant Field Values

idxcmd

private final int idxcmd

Constructor Detail

AdsCommand

protected AdsCommand(int commandid)

Method Detail

getFlag

public int getFlag()

getPayloadLength

public abstract long getPayloadLength()

Returns the length of the payload for the command to send.

Returns:

prepareHeader

public AdsHeader prepareHeader(AdsSocketChannel io,
                               int id)

Prepares the header from static information in the ads socket channel, our command code and the cycle id

Parameters:

io -

id -

Returns:

preparePayload

public abstract AdsPayload preparePayload(AdsSocketChannel io,
                                          AdsHeader h)

Prepares the payload.

parse

public abstract AdsPayload parse(ByteBuffer full,
                                 AdsHeader h)

Parses the reply payload.