gr.uoa.di.madgik.commons.channel.nozzle
Interface INozzleConfig

All Known Implementing Classes:

LocalNozzleConfig, TCPServerNozzleConfig

public interface INozzleConfig

This class provides configuration on the creation of a new channel through a ChannelInlet. Implementations of this interface provide different configuration options for the created channel

Author:

gpapanikos

Nested Class Summary

static class

INozzleConfig.ConfigType

Method Summary

void	Dispose() Disposes the configuration and all underlying state
void	FromXML(Node XML)
void	FromXML(String XML)
IChannelProxy	GetChannelProxy() Gets the channel proxy.
INozzleConfig.ConfigType	GetConfigType()
boolean	GetIsBroadcast() Retrieves whether the channel supports multiple connected ChannelOutlet instances
int	GetRestrictBroadcast() Retrieves the maximum number of connected to the channel ChannelOutlet instances if the channel supports multiple instances as set by the SetIsBroadcast(boolean).
void	SetIsBroadcast(boolean Broadcast) Sets whether the channel supports multiple connected ChannelOutlet instances
void	SetProxy(IChannelProxy ChannelProxy) Sets the proxy.
void	SetRestrictBroadcast(int RestrictBroadcast) Sets the maximum number of connected to the channel ChannelOutlet instances if the channel supports multiple instances as set by the SetIsBroadcast(boolean).
String	ToXML()

Method Detail

GetConfigType

INozzleConfig.ConfigType GetConfigType()

ToXML

String ToXML()
             throws Exception

Throws:

Exception

FromXML

void FromXML(String XML)
             throws Exception

Throws:

Exception

FromXML

void FromXML(Node XML)
             throws Exception

Throws:

Exception

GetChannelProxy

IChannelProxy GetChannelProxy()

Gets the channel proxy.

Returns:

the channel proxy

SetProxy

void SetProxy(IChannelProxy ChannelProxy)

Sets the proxy.

Parameters:

ChannelProxy - the channel proxy

GetIsBroadcast

boolean GetIsBroadcast()

Retrieves whether the channel supports multiple connected ChannelOutlet instances

Returns:

true, if the multiple ChannelOutlet instances can be connected

SetIsBroadcast

void SetIsBroadcast(boolean Broadcast)

Sets whether the channel supports multiple connected ChannelOutlet instances

Parameters:

Broadcast - whether the channel supports multiple connected ChannelOutlet instances

GetRestrictBroadcast

int GetRestrictBroadcast()

Retrieves the maximum number of connected to the channel ChannelOutlet instances if the channel supports multiple instances as set by the SetIsBroadcast(boolean). In case a non positive number is provided, no restrictions are enforced.

Returns:

the number of simultaneously connected ChannelOutlet instances to allow

SetRestrictBroadcast

void SetRestrictBroadcast(int RestrictBroadcast)

Sets the maximum number of connected to the channel ChannelOutlet instances if the channel supports multiple instances as set by the SetIsBroadcast(boolean). In case a non positive number is provided, no restrictions are enforced.

Parameters:

RestrictBroadcast - the number of simultaneously connected ChannelOutlet instances to allow

Dispose

void Dispose()

Disposes the configuration and all underlying state