Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | * or more contributor license agreements. See the NOTICE file |
| 4 | * distributed with this work for additional information |
| 5 | * regarding copyright ownership. The ASF licenses this file |
| 6 | * to you under the Apache License, Version 2.0 (the |
| 7 | * "License"); you may not use this file except in compliance |
| 8 | * with the License. You may obtain a copy of the License at |
| 9 | * |
| 10 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | * |
| 12 | * Unless required by applicable law or agreed to in writing, |
| 13 | * software distributed under the License is distributed on an |
| 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | * KIND, either express or implied. See the License for the |
| 16 | * specific language governing permissions and limitations |
| 17 | * under the License. |
| 18 | */ |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 19 | package org.onlab.netty; |
| 20 | |
| 21 | import java.io.IOException; |
| 22 | |
Madan Jampani | 24f9efb | 2014-10-24 18:56:23 -0700 | [diff] [blame] | 23 | import com.google.common.util.concurrent.ListenableFuture; |
| 24 | |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 25 | /** |
| 26 | * Interface for low level messaging primitives. |
| 27 | */ |
| 28 | public interface MessagingService { |
| 29 | /** |
| 30 | * Sends a message asynchronously to the specified communication end point. |
| 31 | * The message is specified using the type and payload. |
| 32 | * @param ep end point to send the message to. |
| 33 | * @param type type of message. |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 34 | * @param payload message payload bytes. |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 35 | * @throws IOException |
| 36 | */ |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 37 | public void sendAsync(Endpoint ep, String type, byte[] payload) throws IOException; |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 38 | |
| 39 | /** |
| 40 | * Sends a message synchronously and waits for a response. |
| 41 | * @param ep end point to send the message to. |
| 42 | * @param type type of message. |
| 43 | * @param payload message payload. |
| 44 | * @return a response future |
| 45 | * @throws IOException |
| 46 | */ |
Madan Jampani | 24f9efb | 2014-10-24 18:56:23 -0700 | [diff] [blame] | 47 | public ListenableFuture<byte[]> sendAndReceive(Endpoint ep, String type, byte[] payload) throws IOException; |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 48 | |
| 49 | /** |
| 50 | * Registers a new message handler for message type. |
| 51 | * @param type message type. |
| 52 | * @param handler message handler |
| 53 | */ |
| 54 | public void registerHandler(String type, MessageHandler handler); |
| 55 | |
| 56 | /** |
| 57 | * Unregister current handler, if one exists for message type. |
| 58 | * @param type message type |
| 59 | */ |
| 60 | public void unregisterHandler(String type); |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 61 | } |