/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you 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.logstash.execution.queue;

import java.util.Map;

/**
 * Writes to the queue.
 */
public interface QueueWriter {

    /**
     * Pushes a single event to the Queue, blocking indefinitely if the Queue is not ready for a
     * write. Implementations of this interface must produce events from a deep copy of the supplied
     * map because upstream clients of this interface may reuse map instances between calls to push.
     *
     * @param event Logstash event data
     */
    void push(Map<String, Object> event);
}
