A C D G I L M N O R S

A

addMember(String, InetAddress, int, boolean, Date, Date) - Method in class com.unet.warmachine.peerlocator.MembershipList

Creates new member, adds it to list and returns it.

addMemberChangeListener(MemberChangeListener) - Method in class com.unet.warmachine.peerlocator.Agent

Adds listener to receive notification of member online and status value.

Agent - class com.unet.warmachine.peerlocator.Agent.

This class is the agent that locates other members of the group on behalf of its client.

Agent(Configuration, MembershipList) - Constructor for class com.unet.warmachine.peerlocator.Agent

Constructor.

C

CATEGORY_CONNECTION - Static variable in class com.unet.warmachine.peerlocator.Logger

Acknowledgement/rejection of connections between agents.

CATEGORY_DEBUG - Static variable in class com.unet.warmachine.peerlocator.Logger

Various debugging information.

CATEGORY_MEMBER_EXCH - Static variable in class com.unet.warmachine.peerlocator.Logger

Events concerning new members, exchange of membership lists and location.

CATEGORY_MESSAGE_RCVD - Static variable in class com.unet.warmachine.peerlocator.Logger

Details of incoming messages.

CATEGORY_MESSAGE_SENT - Static variable in class com.unet.warmachine.peerlocator.Logger

Details of outgoing messages.

CATEGORY_SEARCH - Static variable in class com.unet.warmachine.peerlocator.Logger

Search algorithm for other agents.

CATEGORY_SERVICE_REQ - Static variable in class com.unet.warmachine.peerlocator.Logger

Service requests and results of public interfaces.

CATEGORY_SOCKET - Static variable in class com.unet.warmachine.peerlocator.Logger

Creation and deletion of sockets.

CATEGORY_STARTSTOP - Static variable in class com.unet.warmachine.peerlocator.Logger

Startup/shutdown information.

CATEGORY_TESTCLIENT - Static variable in class com.unet.warmachine.peerlocator.Logger

Reserved for agent clients.

com.unet.warmachine.peerlocator - package com.unet.warmachine.peerlocator

Creates independent agent service that locates other agents of the same group and notifies client.

Configuration - class com.unet.warmachine.peerlocator.Configuration.

This is a simple data object that configures agent system settings at startup.

Configuration(String) - Constructor for class com.unet.warmachine.peerlocator.Configuration

Constructor.

ConfigurationException - exception com.unet.warmachine.peerlocator.ConfigurationException.

This exception indicates a problem with agent configuration data.

ConfigurationException(int, String) - Constructor for class com.unet.warmachine.peerlocator.ConfigurationException

Constructor.

D

deleteMember(Member) - Method in class com.unet.warmachine.peerlocator.MembershipList

Removes member from list.

G

getAgentName() - Method in class com.unet.warmachine.peerlocator.Configuration

Returns agent name.

getCategoryMask(int) - Static method in class com.unet.warmachine.peerlocator.Logger

Returns lowest severity level that can be displayed for category.

getConfiguration() - Method in class com.unet.warmachine.peerlocator.Agent

Returns configuration used by this agent.

getConnectTimeout() - Method in class com.unet.warmachine.peerlocator.Configuration

Returns connection timeout.

getCreationTime() - Method in class com.unet.warmachine.peerlocator.Member

Returns date and time member was created.

getEndSearchIP() - Method in class com.unet.warmachine.peerlocator.Member

Returns highest, searchable IP address when locating members using dynamically allocated IP.

getGroupName() - Method in class com.unet.warmachine.peerlocator.Member

Returns member group name.

getGroupName() - Method in class com.unet.warmachine.peerlocator.MembershipList

Returns shared group name of members.

getGroupName() - Method in class com.unet.warmachine.peerlocator.Agent

Returns group name of agent.

getInactiveTimeout() - Method in class com.unet.warmachine.peerlocator.Configuration

Returns connection inactive timeout.

getIPAddress() - Method in class com.unet.warmachine.peerlocator.Member

Returns last known IP address of member.

getLastMessageTime() - Method in class com.unet.warmachine.peerlocator.Member

Returns date and time of last message received from member.

getLogMask() - Static method in class com.unet.warmachine.peerlocator.Logger

Returns complete category suppression list encoded as 32-bit integer.

getMaxMemberConnections() - Method in class com.unet.warmachine.peerlocator.Configuration

Returns maximum no of connections that may be open per unlocated member when searching.

getMaxMemberSearches() - Method in class com.unet.warmachine.peerlocator.Configuration

Returns maximum no of member searches that may be running at any one time.

getMember(String) - Method in class com.unet.warmachine.peerlocator.MembershipList

Returns named member, if any.

getMembershipList() - Method in class com.unet.warmachine.peerlocator.Agent

Returns membership list used by this agent.

getModificationTime() - Method in class com.unet.warmachine.peerlocator.Member

Returns date and time address and search details were changed.

getName() - Method in class com.unet.warmachine.peerlocator.Member

Returns member name.

getName() - Method in class com.unet.warmachine.peerlocator.Agent

Returns name of agent, which is unique within group.

getPortNo() - Method in class com.unet.warmachine.peerlocator.Member

Returns TCP port no of member.

getReason() - Method in class com.unet.warmachine.peerlocator.ConfigurationException

Returns reason for exception.

getSearchRetryWait() - Method in class com.unet.warmachine.peerlocator.Configuration

Returns search retry wait.

getSelfMember() - Method in class com.unet.warmachine.peerlocator.Agent

Returns member that represents this agent.

getStartSearchIP() - Method in class com.unet.warmachine.peerlocator.Member

Returns lowest, searchable IP address when locating members using dynamically allocated IP.

getStatus() - Method in class com.unet.warmachine.peerlocator.Member

Returns status value of member.

getStatus() - Method in class com.unet.warmachine.peerlocator.Agent

Returns status value of agent.

getStatus() - Method in class com.unet.warmachine.peerlocator.Configuration

Returns initial status value of agent.

getUseConfigIPAddress() - Method in class com.unet.warmachine.peerlocator.Configuration

Whether agent should use configured IP address, rather than choose an arbitary local address of the appropriate type.

getUsePrivateNetwork() - Method in class com.unet.warmachine.peerlocator.Configuration

Whether agent should use an IP address reserved for private networks as the local address, rather than a global, IANA assigned address.

groupOnlineChanged(Agent) - Method in interface com.unet.warmachine.peerlocator.MemberChangeListener

Notifies that the agent is connected or is no longer connected to at one other member of the group.

I

isGroupOnline() - Method in class com.unet.warmachine.peerlocator.Agent

Whether at least one other member of the group is online.

isGroupRejected() - Method in class com.unet.warmachine.peerlocator.Agent

Whether agent was rejected because of name clash with an existing member.

isMemberLocated(Member) - Method in class com.unet.warmachine.peerlocator.Agent

Whether member is online.

isOnline() - Method in class com.unet.warmachine.peerlocator.Member

Indicates if member has been located.

isRunning() - Method in class com.unet.warmachine.peerlocator.Agent

Whether startup sequence is complete, not shutdown nor in the shutting down.

isStaticIP() - Method in class com.unet.warmachine.peerlocator.Member

Whether member uses statically allocated IP address.

L

Logger - class com.unet.warmachine.peerlocator.Logger.

This class is a simple logger and is used for debugging purposes.

logMessage(int, int, String) - Static method in class com.unet.warmachine.peerlocator.Logger

Displays message to standard output, file or output stream as configured.

logMessage(int, int, String, Exception) - Static method in class com.unet.warmachine.peerlocator.Logger

Displays message, exception class, message and stack trace to standard output, file or output stream as configured.

logOn - Static variable in class com.unet.warmachine.peerlocator.Logger

Whether logging is enabled.

M

Member - class com.unet.warmachine.peerlocator.Member.

This data object represents a known agent and data about them.

MemberChangeListener - interface com.unet.warmachine.peerlocator.MemberChangeListener.

This interface defines how an agent can notify client code of changes to a remote agent (of the same group).

members() - Method in class com.unet.warmachine.peerlocator.MembershipList

Returns list of all members.

MembershipList - class com.unet.warmachine.peerlocator.MembershipList.

This data object is a collection of known members of the same group.

MembershipList(String) - Constructor for class com.unet.warmachine.peerlocator.MembershipList

Constructor.

N

notifyGroupOnlineChanged() - Method in class com.unet.warmachine.peerlocator.Agent

Notifies all listeners that this agent is connected or is no longer connected to at one other member of the group.

O

onlineChanged(Member) - Method in interface com.unet.warmachine.peerlocator.MemberChangeListener

Notifies that a member has been located and is online or has gone offline.

R

REASON_ADDRESS_NOT_ASSIGNED - Static variable in class com.unet.warmachine.peerlocator.ConfigurationException

For statically assigned IP, configured address in member representing agent not assigned to local host; for dynamically assigned IP, no address assigned to local host is within configured range.

REASON_NO_LOCAL_ADDRESS - Static variable in class com.unet.warmachine.peerlocator.ConfigurationException

No local address of appropriate (public or private) type is assigned to local host.

REASON_NOT_IN_MEMBERLIST - Static variable in class com.unet.warmachine.peerlocator.ConfigurationException

Agent name in configuration not found in membership list.

REGISTER_NAME_CLASH - Static variable in class com.unet.warmachine.peerlocator.Agent

Returned by register functions - member name of self is already owned by other member.

REGISTER_NOT_FOUND - Static variable in class com.unet.warmachine.peerlocator.Agent

Returned by register functions - no other member of group found within IP address range.

REGISTER_OK - Static variable in class com.unet.warmachine.peerlocator.Agent

Returned by register functions - registration successful.

register(InetAddress, InetAddress, int) - Method in class com.unet.warmachine.peerlocator.Agent

Attempts to find an agent (of the same group) using the supplied address range and TCP port.

register(InetAddress, int) - Method in class com.unet.warmachine.peerlocator.Agent

Attempts to find an agent (of the same group) using the supplied IP address and TCP port.

removeMemberChangeListener(MemberChangeListener) - Method in class com.unet.warmachine.peerlocator.Agent

Removes listener.

S

setCategoryMask(int, int) - Static method in class com.unet.warmachine.peerlocator.Logger

Sets lowest severity level that can be displayed for category.

setConnectTimeout(int) - Method in class com.unet.warmachine.peerlocator.Configuration

Sets connection timeout.

setEndSearchIP(InetAddress) - Method in class com.unet.warmachine.peerlocator.Member

Sets highest, searchable IP address when locating members using dynamically allocated IP.

setInactiveTimeout(int) - Method in class com.unet.warmachine.peerlocator.Configuration

Sets connection inactive timeout.

setLogFile(String) - Static method in class com.unet.warmachine.peerlocator.Logger

Sets output log file.

setLogMask(int) - Static method in class com.unet.warmachine.peerlocator.Logger

Sets category suppression list encoded as 32-bit integer.

setLogStream(OutputStream) - Static method in class com.unet.warmachine.peerlocator.Logger

Sets output stream for logging messages.

setMaxMemberConnections(int) - Method in class com.unet.warmachine.peerlocator.Configuration

Sets maximum no of connections that may be open per unlocated member when searching.

setMaxMemberSearches(int) - Method in class com.unet.warmachine.peerlocator.Configuration

Sets maximum no of member searches that may be running at any one time.

setSearchLevel(int, int) - Method in class com.unet.warmachine.peerlocator.Member

Sets range of IP addresses that can be searched as deviation from current, known address.

setSearchRetryWait(int) - Method in class com.unet.warmachine.peerlocator.Configuration

Sets search retry wait.

setStartSearchIP(InetAddress) - Method in class com.unet.warmachine.peerlocator.Member

Sets lowest, searchable IP address when locating members using dynamically allocated IP.

setStatus(String) - Method in class com.unet.warmachine.peerlocator.Agent

Sets status value of agent and broadcasts to all other, online agents.

setStatus(String) - Method in class com.unet.warmachine.peerlocator.Configuration

Sets initial status value.

setUseConfigIPAddress(boolean) - Method in class com.unet.warmachine.peerlocator.Configuration

Sets whether agent should use configured IP address, rather than choose an arbitary local address of the appropriate type.

setUsePrivateNetwork(boolean) - Method in class com.unet.warmachine.peerlocator.Configuration

Sets whether agent should use an IP address reserved for private networks as the local address, rather than a global, IANA assigned address.

SEVERITY_DETAIL1 - Static variable in class com.unet.warmachine.peerlocator.Logger

Provides medium level information such as algorithm results, service configuration or events.

SEVERITY_DETAIL2 - Static variable in class com.unet.warmachine.peerlocator.Logger

Provides low level information.

SEVERITY_ERROR - Static variable in class com.unet.warmachine.peerlocator.Logger

The highest severity level and indicates a function has failed or exception that can't be handled.

SEVERITY_INFO - Static variable in class com.unet.warmachine.peerlocator.Logger

Provides high level information such as start or end of major service.

SEVERITY_NONE - Static variable in class com.unet.warmachine.peerlocator.Logger

This severity level is used by setCategoryMask() to suppress all messages of a category; it is not a message severity itself.

SEVERITY_TRACE - Static variable in class com.unet.warmachine.peerlocator.Logger

Records trace of function entry and exits with parameters and results.

SEVERITY_WARNING - Static variable in class com.unet.warmachine.peerlocator.Logger

Indicates an unexpected or erroneous condition that does not make function fail and can be ignored or an exception that can be handled.

shutdown() - Method in class com.unet.warmachine.peerlocator.Agent

Makes agent offline and closes all connections.

size() - Method in class com.unet.warmachine.peerlocator.MembershipList

Returns number of members.

startup() - Method in class com.unet.warmachine.peerlocator.Agent

Makes agent online, starts communications and attempts to locate other agents.

statusValueChanged(Member) - Method in interface com.unet.warmachine.peerlocator.MemberChangeListener

Notifies that a member that has already been declared online has changed status value.

A C D G I L M N O R S