// SMSLib for Java v3
// A Java API library for sending and receiving SMS via a GSM modem
// or other supported gateways.
// Web Site: http://www.smslib.org
//
// Copyright (C) 2002-2009, Thanasis Delenikas, Athens/GREECE.
// SMSLib is distributed under the terms of the Apache License version 2.0
//
// 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 org.smslib;

/**
 * Interface of the callback class used by SMSLib. SMSLib will call this method
 * whenever a gateway retrieves a message from the Queue and before it tries to
 * send it out.
 * 
 * @see Service#setQueueSendingNotification(IQueueSendingNotification)
 */
public interface IQueueSendingNotification
{
	/**
	 * This method will be called by SMSLib whenever a gateway retrieves a
	 * message from the Queue and before it tries to send it out.
	 * 
	 * @param gatewayId
	 *            The id of the gateway from which the message is about to be
	 *            sent from.
	 * @param msg
	 *            The outbound message ready to be sent.
	 */
	void process(final String gatewayId, final OutboundMessage msg);
}