org.eclipse.scada.protocol.arduino

Class ArduinoCodec

java.lang.Object

org.eclipse.scada.protocol.arduino.ArduinoCodec

All Implemented Interfaces:

ProtocolDecoder, ProtocolEncoder

public class ArduinoCodec
extends Object
implements ProtocolEncoder, ProtocolDecoder

Constructor Summary

Constructors

Constructor and Description
ArduinoCodec()

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(IoSession session, IoBuffer data, ProtocolDecoderOutput output) Decodes binary or protocol-specific content into higher-level message objects.
void	dispose(IoSession session) Releases all resources related with this encoder.
void	encode(IoSession session, Object message, ProtocolEncoderOutput output) Encodes higher-level message objects into binary or protocol-specific data.
void	finishDecode(IoSession session, ProtocolDecoderOutput output) Invoked when the specified session is closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArduinoCodec

public ArduinoCodec()

Method Detail

decode

public void decode(IoSession session,
          IoBuffer data,
          ProtocolDecoderOutput output)
            throws Exception

Description copied from interface: ProtocolDecoder

Decodes binary or protocol-specific content into higher-level message objects. MINA invokes ProtocolDecoder.decode(IoSession, IoBuffer, ProtocolDecoderOutput) method with read data, and then the decoder implementation puts decoded messages into ProtocolDecoderOutput.

Specified by:

decode in interface ProtocolDecoder

Throws:

Exception - if the read data violated protocol specification

finishDecode

public void finishDecode(IoSession session,
                ProtocolDecoderOutput output)
                  throws Exception

Description copied from interface: ProtocolDecoder

Invoked when the specified session is closed. This method is useful when you deal with the protocol which doesn't specify the length of a message such as HTTP response without content-length header. Implement this method to process the remaining data that ProtocolDecoder.decode(IoSession, IoBuffer, ProtocolDecoderOutput) method didn't process completely.

Specified by:

finishDecode in interface ProtocolDecoder

Throws:

Exception - if the read data violated protocol specification

dispose

public void dispose(IoSession session)
             throws Exception

Description copied from interface: ProtocolEncoder

Releases all resources related with this encoder.

Specified by:

dispose in interface ProtocolDecoder

Specified by:

dispose in interface ProtocolEncoder

Throws:

Exception - if failed to dispose all resources

encode

public void encode(IoSession session,
          Object message,
          ProtocolEncoderOutput output)
            throws Exception

Description copied from interface: ProtocolEncoder

Encodes higher-level message objects into binary or protocol-specific data. MINA invokes ProtocolEncoder.encode(IoSession, Object, ProtocolEncoderOutput) method with message which is popped from the session write queue, and then the encoder implementation puts encoded messages (typically IoBuffers) into ProtocolEncoderOutput.

Specified by:

encode in interface ProtocolEncoder

Throws:

Exception - if the message violated protocol specification