framework/src/main/java/org/opendaylight/protocol/framework/ProtocolInputStreamFactory.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.protocol.framework;
   9
  10 import java.io.PipedInputStream;
  11
  12 /**
  13  * Factory for creating Protocol input streams. Should be implemented to return protocol
  14  * specific input stream.
  15  */
  16 public interface ProtocolInputStreamFactory {
  17
  18         /**
  19          * Creates and returns protocol input stream.
  20          * @param pis underlying piped input stream
  21          * @param pmf protocol message factory
  22          * @return protocol specific input stream
  23          */
  24         ProtocolInputStream getProtocolInputStream(PipedInputStream pis, ProtocolMessageFactory pmf);
  25 }