ProtocolDescriptor (QD Core API 3.352)

java.lang.Object
- com.devexperts.qd.qtp.ProtocolDescriptor

```
@Internal
public final class ProtocolDescriptor
extends Object
```
Descriptor for QTP protocol that is sent in DESCRIBE_PROTOCOL message.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AGGREGATION_PERIOD_INFO_PROPERTY` Per-message property carrying the server's actual aggregation period as a `TimePeriodInfo` JSON string: `{"min":1.5,"max":2.0}` (seconds with decimals).
`static String`	`AUTHENTICATION_PROPERTY` Authentication challenge/response between server and client during login handshake.
`static String`	`AUTHORIZATION_PROPERTY` Authorization token sent from client to server (e.g., "Basic base64..." or "Bearer token").
`static String`	`BASIC_AUTHORIZATION` Scheme identifier for HTTP Basic authentication, used as a prefix in `AUTHORIZATION_PROPERTY` values.
`static String`	`FILTER_PROPERTY` Connection filter in `QDFilter` syntax.
`static String`	`MAGIC_STRING` This string identifies protocol descriptor message.
`static String`	`NAME_PROPERTY` Human-readable endpoint name for logging and diagnostics.
`static String`	`OPT_PROPERTY` Serialization options affecting wire format (e.g., "hs" enables EventFlags storage).
`static String`	`REQUESTED_AGGREGATION_PERIOD_PROPERTY` Client's requested data aggregation period as a `TimePeriod` string (e.g., "1s", "0.5s").
`static String`	`RMI_PROPERTY` RMI endpoint role identifier (e.g., "CLIENT", "SERVER").
`static String`	`SERVICES_PROPERTY` Available RMI services in ServiceFilter syntax.
`static String`	`STRIPE_PROPERTY` Symbol striping filter in `QDFilter` syntax (using SymbolStriper).
`static String`	`TIME_PROPERTY` Timestamp format for event time embedding (e.g., "millis", "seconds", "nanos").
`static String`	`TYPE_PROPERTY` Protocol/format type identifier (e.g., "qtp" for socket QTP, "tape" for tape files).
`static String`	`VERSION_PROPERTY` Implementation version in free text form.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addReceive(MessageDescriptor message)`
`void`	`addSend(MessageDescriptor message)`
`int`	`appendFromTextTokens(List<String> tokens, int i)` Adds information to this protocol descriptor from a list of strings that are parsed from tab or comma separated text format.
`boolean`	`canReceive(MessageType message)`
`boolean`	`canSend(MessageType message)`
`void`	`composeTo(com.devexperts.io.BufferedOutput out)` Composes this protocol descriptor in compact binary format including its `MAGIC_STRING`.
`List<String>`	`convertToTextTokens()` Converts this protocol descriptor to a list of strings for representation in tab or comma separated text format.
`ProtocolDescriptor`	`deltaFrom(ProtocolDescriptor prev)` Returns `current` as-is when `prev == null` (first emission is always full); otherwise returns a descriptor containing only the top-level properties and per-message properties whose values differ from `prev`.
`com.devexperts.connector.proto.EndpointId`	`getEndpointId()`
`Map<String,String>`	`getProperties()`
`String`	`getProperty(String key)`
`MessageDescriptor`	`getReceive(MessageType message)`
`Set<MessageDescriptor>`	`getReceiveMessages()`
`EnumSet<MessageType>`	`getReceiveSet()`
`MessageDescriptor`	`getSend(MessageType message)`
`Set<MessageDescriptor>`	`getSendMessages()`
`EnumSet<MessageType>`	`getSendSet()`
`void`	`mergeFrom(ProtocolDescriptor delta)` Merges `delta` into this descriptor with the same accumulation semantics as `parseFrom(BufferedInput)`: top-level properties are `putAll`-ed; per-message descriptors with the same id have their properties `putAll`-ed into the existing one, while new ids are added as reparented copies; a non-null `endpointId` overrides.
`static ProtocolDescriptor`	`newEmptyProtocolDescriptor()` Creates an empty protocol descriptor with no properties and no message descriptors.
`MessageDescriptor`	`newMessageDescriptor(int id, String name)`
`MessageDescriptor`	`newMessageDescriptor(MessageType messageType)`
`static ProtocolDescriptor`	`newPeerProtocolDescriptor(ProtocolDescriptor previouslyRead)`
`static ProtocolDescriptor`	`newPeerProtocolDescriptorReadAs(ProtocolDescriptor original, MessageType readAs)`
`static ProtocolDescriptor`	`newSelfProtocolDescriptor(String type)` Creates empty protocol description for a specified type with an embedded QDS version.
`void`	`parseFrom(com.devexperts.io.BufferedInput in)` Parses protocol descriptor from compact binary format including its `MAGIC_STRING`.
`void`	`setEndpointId(com.devexperts.connector.proto.EndpointId endpointId)`
`void`	`setProperty(String key, String value)`
`String`	`toString()`

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

- Field Detail
  - MAGIC_STRING
```
public static final String MAGIC_STRING
```
    This string identifies protocol descriptor message.
    
    See Also:
    
    Constant Field Values
  - TYPE_PROPERTY
```
public static final String TYPE_PROPERTY
```
    Protocol/format type identifier (e.g., "qtp" for socket QTP, "tape" for tape files). Set by both sides during initialization.
    
    See Also:
    
    Constant Field Values
  - VERSION_PROPERTY
```
public static final String VERSION_PROPERTY
```
    Implementation version in free text form. SHOULD NOT be used to determine compatibility or supported feature set. MAY be used to work around known bugs in specific implementations.
    
    See Also:
    
    Constant Field Values
  - OPT_PROPERTY
```
public static final String OPT_PROPERTY
```
    Serialization options affecting wire format (e.g., "hs" enables EventFlags storage). Parsed into ProtocolOption set. Affects message encoding and decoding.
    
    See Also:
    
    Constant Field Values
  - TIME_PROPERTY
```
public static final String TIME_PROPERTY
```
    Timestamp format for event time embedding (e.g., "millis", "seconds", "nanos"). Indicates whether and how event times are present in the data stream.
    
    See Also:
    
    Constant Field Values
  - NAME_PROPERTY
```
public static final String NAME_PROPERTY
```
    Human-readable endpoint name for logging and diagnostics. Set via endpoint configuration; helps distinguish multiple connections in the same JVM.
    
    See Also:
    
    Constant Field Values
  - FILTER_PROPERTY
```
public static final String FILTER_PROPERTY
```
    Connection filter in QDFilter syntax. MAY be used to determine what data the remote side will ignore, to avoid sending it for performance reasons.
    
    See Also:
    
    Constant Field Values
  - STRIPE_PROPERTY
```
public static final String STRIPE_PROPERTY
```
    Symbol striping filter in QDFilter syntax (using SymbolStriper). Coordinates symbol partitioning across connections for load distribution.
    
    See Also:
    
    Constant Field Values
  - SERVICES_PROPERTY
```
public static final String SERVICES_PROPERTY
```
    Available RMI services in ServiceFilter syntax. Set on per-message descriptors (RMI_ADVERTISE_SERVICES) by RMI-enabled endpoints.
    
    See Also:
    
    Constant Field Values
  - AUTHORIZATION_PROPERTY
```
public static final String AUTHORIZATION_PROPERTY
```
    Authorization token sent from client to server (e.g., "Basic base64..." or "Bearer token"). Masked in logs for security; only the scheme prefix is shown in diagnostic output.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_PROPERTY
```
public static final String AUTHENTICATION_PROPERTY
```
    Authentication challenge/response between server and client during login handshake. Server sends a reason or challenge; empty string signals successful acknowledgement.
    
    See Also:
    
    Constant Field Values
  - RMI_PROPERTY
```
public static final String RMI_PROPERTY
```
    RMI endpoint role identifier (e.g., "CLIENT", "SERVER"). Enables the remote side to determine RMI role compatibility.
    
    See Also:
    
    Constant Field Values
  - BASIC_AUTHORIZATION
```
public static final String BASIC_AUTHORIZATION
```
    Scheme identifier for HTTP Basic authentication, used as a prefix in AUTHORIZATION_PROPERTY values.
    
    See Also:
    
    Constant Field Values
  - REQUESTED_AGGREGATION_PERIOD_PROPERTY
```
public static final String REQUESTED_AGGREGATION_PERIOD_PROPERTY
```
    Client's requested data aggregation period as a TimePeriod string (e.g., "1s", "0.5s"). Set per message type (TICKER_DATA, STREAM_DATA, HISTORY_DATA). Server clamps to its configured bounds; empty string signals reset to server default.
    
    See Also:
    
    Constant Field Values
  - AGGREGATION_PERIOD_INFO_PROPERTY
```
public static final String AGGREGATION_PERIOD_INFO_PROPERTY
```
    Per-message property carrying the server's actual aggregation period as a TimePeriodInfo JSON string: {"min":1.5,"max":2.0} (seconds with decimals).
    
    See Also:
    
    Constant Field Values
- Method Detail
  - newSelfProtocolDescriptor
```
public static ProtocolDescriptor newSelfProtocolDescriptor(String type)
```
    Creates empty protocol description for a specified type with an embedded QDS version. Types are used for files and should be short camel-case strings like "qtp" for socket QTP protocol, "tape" for generic tape files, "snapshot", "extract", etc.
    
    Parameters:
    
    type - the type.
    
    Returns:
    
    new protocol descriptor.
  - newPeerProtocolDescriptor
```
public static ProtocolDescriptor newPeerProtocolDescriptor(ProtocolDescriptor previouslyRead)
```
  - newEmptyProtocolDescriptor
```
public static ProtocolDescriptor newEmptyProtocolDescriptor()
```
    Creates an empty protocol descriptor with no properties and no message descriptors. Intended for parsing a single on-wire DESCRIBE_PROTOCOL message in isolation, so the resulting descriptor reflects exactly the bytes received and can later be merged into an accumulator via mergeFrom(ProtocolDescriptor).
  - newPeerProtocolDescriptorReadAs
```
public static ProtocolDescriptor newPeerProtocolDescriptorReadAs(ProtocolDescriptor original,
                                                                 MessageType readAs)
```
  - newMessageDescriptor
```
public MessageDescriptor newMessageDescriptor(MessageType messageType)
```
  - newMessageDescriptor
```
public MessageDescriptor newMessageDescriptor(int id,
                                              String name)
```
  - getEndpointId
```
public com.devexperts.connector.proto.EndpointId getEndpointId()
```
  - setEndpointId
```
public void setEndpointId(com.devexperts.connector.proto.EndpointId endpointId)
```
  - getProperties
```
public Map<String,String> getProperties()
```
  - getSendMessages
```
public Set<MessageDescriptor> getSendMessages()
```
  - getReceiveMessages
```
public Set<MessageDescriptor> getReceiveMessages()
```
  - getProperty
```
public String getProperty(String key)
```
  - setProperty
```
public void setProperty(String key,
                        String value)
```
  - canSend
```
public boolean canSend(MessageType message)
```
  - canReceive
```
public boolean canReceive(MessageType message)
```
  - getSendSet
```
public EnumSet<MessageType> getSendSet()
```
  - getSend
```
public MessageDescriptor getSend(MessageType message)
```
  - getReceiveSet
```
public EnumSet<MessageType> getReceiveSet()
```
  - getReceive
```
public MessageDescriptor getReceive(MessageType message)
```
  - addSend
```
public void addSend(MessageDescriptor message)
```
  - addReceive
```
public void addReceive(MessageDescriptor message)
```
  - mergeFrom
```
public void mergeFrom(ProtocolDescriptor delta)
```
    Merges delta into this descriptor with the same accumulation semantics as parseFrom(BufferedInput): top-level properties are putAll-ed; per-message descriptors with the same id have their properties putAll-ed into the existing one, while new ids are added as reparented copies; a non-null endpointId overrides.
  - deltaFrom
```
public ProtocolDescriptor deltaFrom(ProtocolDescriptor prev)
```
    Returns current as-is when prev == null (first emission is always full); otherwise returns a descriptor containing only the top-level properties and per-message properties whose values differ from prev.
  - composeTo
```
public void composeTo(com.devexperts.io.BufferedOutput out)
               throws IOException
```
    Composes this protocol descriptor in compact binary format including its MAGIC_STRING.
    
    Throws:
    
    IOException
  - parseFrom
```
public void parseFrom(com.devexperts.io.BufferedInput in)
               throws IOException
```
    Parses protocol descriptor from compact binary format including its MAGIC_STRING.
    
    Throws:
    
    IOException - when descriptor cannot be read due to wrong magic or other reasons.
  - convertToTextTokens
```
public List<String> convertToTextTokens()
```
    Converts this protocol descriptor to a list of strings for representation in tab or comma separated text format. It does not include its MAGIC_STRING.
  - appendFromTextTokens
```
public int appendFromTextTokens(List<String> tokens,
                                int i)
```
    Adds information to this protocol descriptor from a list of strings that are parsed from tab or comma separated text format.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ProtocolDescriptor

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAGIC_STRING

TYPE_PROPERTY

VERSION_PROPERTY

OPT_PROPERTY

TIME_PROPERTY

NAME_PROPERTY

FILTER_PROPERTY

STRIPE_PROPERTY

SERVICES_PROPERTY

AUTHORIZATION_PROPERTY

AUTHENTICATION_PROPERTY

RMI_PROPERTY

BASIC_AUTHORIZATION

REQUESTED_AGGREGATION_PERIOD_PROPERTY

AGGREGATION_PERIOD_INFO_PROPERTY

Method Detail

newSelfProtocolDescriptor

newPeerProtocolDescriptor

newEmptyProtocolDescriptor

newPeerProtocolDescriptorReadAs

newMessageDescriptor

newMessageDescriptor

getEndpointId

setEndpointId

getProperties

getSendMessages

getReceiveMessages

getProperty

setProperty

canSend

canReceive

getSendSet

getSend

getReceiveSet

getReceive

addSend

addReceive

mergeFrom

deltaFrom

composeTo

parseFrom

convertToTextTokens

appendFromTextTokens

toString