EmitterEnvelopeHook.java

/*
 * Copyright 2014 University of Southern California
 *
 * 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 edu.usc.pgroup.floe.app;

import org.zeromq.ZMQ;

/**
 * @author kumbhare
 */
public interface EmitterEnvelopeHook {
    /**
     * Used by specific pellet types (e.g. reducers) to put additional frames
     * in the message
     * @param socket the ZMQ socket to add the envelope.
     * @param tuple the tuple for which the envelope is to be added.
     */
    void addEnvelope(ZMQ.Socket socket, Tuple tuple);
}