FlowCacheQueryResp.java

/*
 * Copyright (c) 2013 Big Switch Networks, Inc.
 *
 * Licensed under the Eclipse Public License, Version 1.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.eclipse.org/legal/epl-v10.html
 *
 * 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.sdnplatform.flowcache;

import java.util.ArrayList;

/**
 * Object to return flows in response to a query message to BetterFlowCache.
 * This object is passed in the flowQueryRespHandler() callback.
 */
public class FlowCacheQueryResp {

    /** query object provided by the caller, returned unchanged. */
    public FCQueryObj  queryObj;
    /** 
     * Set to true if more flows could be returned for this query in
     * additional callbacks. Set of false in the last callback for the
     * query. 
     */
    public boolean     moreFlag;
    
    /**
     * Set to true if the response has been sent to handler
     */
    public boolean     hasSent;
    
    /** 
     * The flow list. If there are large number of flows to be returned
     * then they may be returned in multiple callbacks.
     */
    public ArrayList<QRFlowCacheObj> qrFlowCacheObjList;

    /**
     * Instantiates a new flow cache query response.
     *
     * @param query the flow cache query object as given by the caller of
     * flow cache submit query API.
     */
    public FlowCacheQueryResp(FCQueryObj query) {
        qrFlowCacheObjList = new ArrayList<QRFlowCacheObj>();
        queryObj    = query;
        moreFlag    = false;
        hasSent     = false;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        String s = queryObj.toString() + "; moreFlasg=" + moreFlag +
                   "; hasSent=" + hasSent;
        s += "; FlowCount=" + Integer.toString(qrFlowCacheObjList.size());
        return s;
    }
}