bt.protocol.extended

Interface ExtendedMessageTypeMapping

All Known Implementing Classes:

AlphaSortedMapping

public interface ExtendedMessageTypeMapping

Represents a set of mappings between message types (both literal names and Java types) and their numeric IDs.

Used in «BEP-10: Extension Protocol» for communicating client-specific message type IDs to peers.

All mappings are listed as a set of key-value pairs in a dictionary of supported message types in the extended handshake. In each pair, key is the literal name of a message type, and value is a unique numeric ID, assigned to this message type. Numeric message type IDs are then included in the binary representation of a message and can be used to determine the type of this message.

Since:

1.0

See Also:

BEP-10: Extension Protocol

Method Summary

Modifier and Type	Method and Description
Integer	getIdForTypeName(String typeName) Get numeric ID for a message type with a given literal name.
String	getTypeNameForId(Integer typeId) Get literal name of a message type with a given numeric ID.
String	getTypeNameForJavaType(Class<?> type) Get literal name for a message type.
void	visitMappings(BiConsumer<String,Integer> visitor) Visitor interface for all mappings, contained in this set.

Method Detail

getTypeNameForId

String getTypeNameForId(Integer typeId)

Get literal name of a message type with a given numeric ID.

Parameters:

typeId - Numeric message type ID

Returns:

Message type name

Since:

1.0

getIdForTypeName

Integer getIdForTypeName(String typeName)

Get numeric ID for a message type with a given literal name.

Parameters:

typeName - Message type name

Returns:

Numeric message type ID

Since:

1.0

getTypeNameForJavaType

String getTypeNameForJavaType(Class<?> type)

Get literal name for a message type.

Parameters:

type - Message Java type

Returns:

Message type name

Since:

1.0

visitMappings

void visitMappings(BiConsumer<String,Integer> visitor)

Visitor interface for all mappings, contained in this set.

Parameters:

visitor - First parameter is message type name, second parameter is numeric message type ID.

Since:

1.0