Package rst.generic

Message which are capable of handling dynamic data types.

This is not the preferred way of using RST, but cannot be avoided in certain cases. If possible, use semantically-defined data types.

Messages

• MethodCall
• Dictionary
• KeyValuePair
• Value

clearer: should be made invisible via css

Message MethodCall

class rst.generic.MethodCall

Represents a call to a named method with multiple <Could not resolve reference to Value> as arguments.

Code author: Johannes Wienke <jwienke@techfak.uni-bielefeld.de>

name

Type :OCTET-VECTOR

Name of the method to call.

ASCII string.

arguments

Type :array of rst.generic.Value

The method arguments.

Download this file

message MethodCall {

    /**
     * Name of the method to call.
     *
     * ASCII string.
     */
    required bytes name = 1;

    /**
     * The method arguments.
     */
    repeated Value arguments = 2;

}

Message Dictionary

class rst.generic.Dictionary

A list of key-value pairs.

Code author: Arne Nordmann <anordman@techfak.uni-bielefeld.de>

entries

Type :array of rst.generic.KeyValuePair

The list of key-value pairs.

Ordering is ignored and duplicated keys must be avoided.

Download this file

message Dictionary {

    /**
     * The list of key-value pairs.
     *
     * Ordering is ignored and duplicated keys must be avoided.
     */
    repeated KeyValuePair entries = 1;

}

Message KeyValuePair

class rst.generic.KeyValuePair

Combines a generic value with an identifying string key.

Code author: Arne Nordmann <anordman@techfak.uni-bielefeld.de>

key

Type :ASCII-STRING

The key of this entry.

value

Type :rst.generic.Value

The value.

Download this file

message KeyValuePair {

    /**
     * The key of this entry.
     */
    required string key = 1;

    /**
     * The value.
     */
    required Value value = 2;

}

Message Value

class rst.generic.Value

A representation of a generic value with a dynamic type.

Each value has a declared type in type indicating which of the remaining type-specific fields contains the value, expect for VOID, where no value is transported at all (most useful for return types).

Code author: Johannes Wienke <jwienke@techfak.uni-bielefeld.de>

type

Type :rst.generic.Value.Type

The type of the value transported in this message.

int

Type :INT64

Not documented

double

Type :FLOAT64

Not documented

string

Type :ASCII-STRING

Not documented

bool

Type :BOOL

Not documented

binary

Type :OCTET-VECTOR

Not documented

array

Type :array of rst.generic.Value

Contained elements can be of different types and ordering is important.

Download this file

package rst.generic;

option java_outer_classname = "ValueType";

/**
 * A representation of a generic value with a dynamic type.
 *
 * Each value has a declared type in @ref .type indicating which of the
 * remaining type-specific fields contains the value, expect for
 * @ref .Type.VOID, where no value is transported at all (most useful for return
 * types).
 *
 * @author Johannes Wienke <jwienke@techfak.uni-bielefeld.de>
 */
message Value {

    /**
     * The list of supported types.
     */
    enum Type {
        VOID = 1;
        INT = 2;
        DOUBLE = 3;
        STRING = 4;
        BOOL = 5;
        BINARY = 6;
        /**
         * Indicate that a list of Values is contained in @ref Value.array
         * representing an array.
         */
        ARRAY = 7;
    }

    /**
     * The type of the value transported in this message.
     */
    required Type type = 1;

    optional int64 int = 2;
    optional double double = 3;
    optional string string = 4;
    optional bool bool = 5;
    optional bytes binary = 6;
    /**
     * Contained elements can be of different types and ordering is important.
     */
    repeated Value array = 7;

}

Message Type

class rst.generic.Value.Type

The list of supported types.

VOID

= 1

Not documented

INT

= 2

Not documented

DOUBLE

= 3

Not documented

STRING

= 4

Not documented

BOOL

= 5

Not documented

BINARY

= 6

Not documented

ARRAY

= 7

Indicate that a list of Values is contained in <Could not resolve reference to Value.array> representing an array.

Download this file

    enum Type {
        VOID = 1;
        INT = 2;
        DOUBLE = 3;
        STRING = 4;
        BOOL = 5;
        BINARY = 6;
        /**
         * Indicate that a list of Values is contained in @ref Value.array
         * representing an array.
         */
        ARRAY = 7;
    }