org.eclipse.scada.protocol.iec60870.asdu

Class MessageManager

java.lang.Object

org.eclipse.scada.protocol.iec60870.asdu.MessageManager

public class MessageManager
extends Object

Constructor Summary

Constructors

Constructor and Description
MessageManager(ProtocolOptions options)

Method Summary

Methods

Modifier and Type	Method and Description
void	encodeMessage(Object msg, io.netty.buffer.ByteBuf buf)
protected void	handleUnknownMessage(byte typeId, ASDUHeader header, io.netty.buffer.ByteBuf data)
io.netty.buffer.ByteBuf	receiveMessage(InformationTransfer informationTransfer, List<Object> out)
<T> void	registerClass(Class<T> clazz) Register a message class to the protocol stack
void	registerCodec(byte typeId, InformationStructure informationStructure, MessageCodec codec)
protected void	registerCodec(org.eclipse.scada.protocol.iec60870.asdu.MessageManager.MessageTypeId messageTypeId, MessageCodec codec)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageManager

public MessageManager(ProtocolOptions options)

Method Detail

receiveMessage

public io.netty.buffer.ByteBuf receiveMessage(InformationTransfer informationTransfer,
                                     List<Object> out)

encodeMessage

public void encodeMessage(Object msg,
                 io.netty.buffer.ByteBuf buf)

handleUnknownMessage

protected void handleUnknownMessage(byte typeId,
                        ASDUHeader header,
                        io.netty.buffer.ByteBuf data)

registerCodec

protected void registerCodec(org.eclipse.scada.protocol.iec60870.asdu.MessageManager.MessageTypeId messageTypeId,
                 MessageCodec codec)

registerCodec

public void registerCodec(byte typeId,
                 InformationStructure informationStructure,
                 MessageCodec codec)

registerClass

public <T> void registerClass(Class<T> clazz)

Register a message class to the protocol stack

If the requirements posed by this method don't fit the message class to be registered it is possible to write a complete custom message codec using registerCodec(byte, InformationStructure, MessageCodec).

The message class must:

• Provide a static method with the signature : public static T parse ( ProtocolOptions, byte, ASDUHeader, ByteBuf )
• Provide a non-static method with the signature : public void encode ( ProtocolOptions, ByteBuf )

In addition the class should implement the following interfaces

Encodeable

Providing an interface for the required Encodeable.encode(ProtocolOptions, ByteBuf) method.

Dumpable

In order to provide a common way to dump the message structure to some log

Parameters:

clazz - the message class to register