org.javagroups.protocols
Class AUTOCONF

java.lang.Object
  |
  +--org.javagroups.stack.Protocol
        |
        +--org.javagroups.protocols.AUTOCONF

public class AUTOCONF
extends Protocol

Senses the network configuration when it is initialized (in init()) and sends a CONFIG event up and down the stack. The CONFIG event contains a hashmap, with strings as keys (e.g. "frag_size") and Objects as values. Certain protocols can set some of their properties when receiving the CONFIG event.
This protocol should be placed above the transport protocol (e.g. UDP). It is not needed for TCP.
Example: senses the network send and receive buffers, plus the max size of a message to be sent and generates a CONFIG event containing "frag_size", "send_buf_size" and "receive_buf_size" keys.

Author:
Bela Ban

Fields inherited from class org.javagroups.stack.Protocol
down_handler, down_prot, down_queue, down_thread, observer, props, stack, up_handler, up_prot, up_queue, up_thread
 
Constructor Summary
AUTOCONF()
           
 
Method Summary
 void down(Event evt)
          An event is to be sent down the stack.
 java.lang.String getName()
           
 void init()
          Called after instance has been created (null constructor) and before protocol is started
 boolean setProperties(java.util.Properties props)
          Setup the Protocol instance acording to the configuration string
 void startDownHandler()
          Leave empty: no down_thread will be created, but the down_thread of the neighbor above us will be used
 void startUpHandler()
          Leave empty: no up_thread will be created, but the up_thread of the neighbor below us will be used
 void up(Event evt)
          An event was received from the layer below.
 
Methods inherited from class org.javagroups.stack.Protocol
getDownProtocol, getDownQueue, getProperties, getUpProtocol, getUpQueue, passDown, passUp, providedDownServices, providedUpServices, receiveDownEvent, receiveUpEvent, requiredDownServices, requiredUpServices, setDownProtocol, setObserver, setPropertiesInternal, setProtocolStack, setUpProtocol, stopInternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AUTOCONF

public AUTOCONF()
Method Detail

getName

public java.lang.String getName()
Overrides:
getName in class Protocol

init

public void init()
          throws java.lang.Exception
Description copied from class: Protocol
Called after instance has been created (null constructor) and before protocol is started
Overrides:
init in class Protocol

setProperties

public boolean setProperties(java.util.Properties props)
Setup the Protocol instance acording to the configuration string
Overrides:
setProperties in class Protocol

up

public void up(Event evt)
Description copied from class: Protocol
An event was received from the layer below. Usually the current layer will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using passDown() or c) the event (or another event) is sent up the stack using passUp().
Overrides:
up in class Protocol

down

public void down(Event evt)
Description copied from class: Protocol
An event is to be sent down the stack. The layer may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the layer may need to add a header to it (or do nothing at all) before sending it down the stack using passDown(). In case of a GET_ADDRESS event (which tries to retrieve the stack's address from one of the bottom layers), the layer may need to send a new response event back up the stack using passUp().
Overrides:
down in class Protocol

startUpHandler

public void startUpHandler()
Leave empty: no up_thread will be created, but the up_thread of the neighbor below us will be used
Overrides:
startUpHandler in class Protocol

startDownHandler

public void startDownHandler()
Leave empty: no down_thread will be created, but the down_thread of the neighbor above us will be used
Overrides:
startDownHandler in class Protocol


Copyright © 2001,2002 www.javagroups.com . All Rights Reserved.