/*
 * Copyright 2023 epimethix@protonmail.com
 * 
 * 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 com.github.epimethix.lumicore.ipc;

/**
 * {@code MessageListener} interface for receiving messages from an
 * {@code IPCController}. Use
 * {@code IPCController#addMessagesListener(MessageListener)} to register the
 * {@code MessageListener} implementation.
 * 
 * @author epimethix
 * @see IPCController
 * @see FileSystemIPCController
 */
public interface MessageListener {
	/**
	 * This method will be invoked by the {@code IPCController}s this
	 * {@code MessageListener} is associated with. If the {@code IPCController} is
	 * in {@code IPCController.Mode#SENDER} mode then {@code receive(String)} should
	 * never be called.
	 * 
	 * @param message the message to process
	 */
	void receive(String message);
}
