com.slytechs.jnetstream.protocol
Interface Protocol

All Known Implementing Classes:

LegacyProtocol

public interface Protocol

Defines access to a Protocol. Protocols are supplied to help deal with disecting raw packet byte buffers, analyzing protocol specific structure and state. Also verify protocol integrity and check for errors.

Since:

0.2.4

Author:

Mark Bednarczyk, Sly Technologies, Inc

Method Summary

java.util.Set	getAvailableProtocolImplementationTypes() Returns a set of available types (ProtocolType) for this specific protocol.
java.lang.String	getName() Returns the name of this protocol.
ProtocolImplementationType	getProtocolImplementationType() Returns the current implementation type of this specific protocol.
java.util.List	getSinkBindings() Returns a list of Bindings that are bound to this protocol.
java.util.List	getSourceBindings() Returns a list of Bindings that are defined for this protocol.
java.net.URL	getURL() Get the URL which points to the defininition of this protocol.
boolean	isLoaded() Checks if the current protocol has been loaded.
void	load() Loads the protocol into memory from source definition.

Method Detail

getName

java.lang.String getName()

Returns the name of this protocol. Protocol names are unique.

Returns:

name of this protocol

getSourceBindings

java.util.List getSourceBindings()

Returns a list of Bindings that are defined for this protocol. The bindings links between a sourc and a sink protocol. This is the list of the bindings at the source.

Returns:

list of source bindings

getSinkBindings

java.util.List getSinkBindings()

Returns a list of Bindings that are bound to this protocol. The Sink protocol evaluates the binding expression to determine if the source protocol (the one binding to it) is a candidate for parsing the next portion of the packet.

Returns:

list of sink bindings

isLoaded

boolean isLoaded()

Checks if the current protocol has been loaded. The protocol doesn't have to be loaded, which means this is just a stub protocol.

Returns:

true if protocol has been loaded, otherwise false.

load

void load()
          throws ProtocolDeclarationException,
                 ProtocolNotFoundException,
                 java.io.IOException

Loads the protocol into memory from source definition. This is typically done on demand, only when needed, but the user can load a protocol at any time. This method can also be used to check for syntax errors as this will cause the source file to be compiled. Although the protocol will be loaded, it will not be linked into the environment. Linking only happens when all of the protocol dependencies have been fulfilled and right before the protocol is to be used for the first time.

Throws:

java.io.IOException - any protocols while trying to physically access the protocol definition

ProtocolNotFoundException - protocol definition was not found at the specified url

ProtocolDeclarationException - declaration or syntax errors. Declaration error is the one that does not technically generate a NPL syntax error in the source, but declares an invalid object that can not be used as a protocol. Only Headers and Family object can be used as protocol declarations.

getURL

java.net.URL getURL()

Get the URL which points to the defininition of this protocol. This may be a local file or remote HTTP url.

Returns:

the url of the source code for this protocol

getProtocolImplementationType

ProtocolImplementationType getProtocolImplementationType()

Returns the current implementation type of this specific protocol. This is dependent on the discovery of the protocol and implementation types available. The runtime system will choose the most efficient type of protocol implementation to utilize, based on the available set.

Returns:

type of this specific protocol

getAvailableProtocolImplementationTypes

java.util.Set getAvailableProtocolImplementationTypes()

Returns a set of available types (ProtocolType) for this specific protocol. Each protocol may have different implementation types available and this method will return all available as a set.

Returns:

Set containing the ProtocolType enum constants as values.