/*
 * Copyright 2006 National Institute of Advanced Industrial Science
 * and Technology (AIST), and contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ow.stat;

import ow.id.ID;
import ow.messaging.MessageReceiver;
import ow.messaging.MessagingAddress;
import ow.messaging.MessagingProvider;

/**
 * An interface through which an application collect statistical information
 * from the messaging subsystem.
 */
public interface MessagingCollector {
	/**
	 * Registers a callback and start this statistics collector.
	 */
	void start(MessagingCallback callback) throws Exception;

	/**
	 * Stops this statistics collector.
	 */
	void stop();

	/**
	 * Returns the ID of the node having the specified address.
	 *
	 * @return null if unknown.
	 */
	ID getID(MessagingAddress address);

	MessagingProvider getMessagingProvider();

	MessageReceiver getMessageReceiver();
}
