Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 2 | * Copyright 2014 Open Networking Laboratory |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 15 | */ |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 16 | package org.onlab.netty; |
| 17 | |
| 18 | import java.io.IOException; |
Madan Jampani | 2bfa94c | 2015-04-11 05:03:49 -0700 | [diff] [blame] | 19 | import java.util.concurrent.CompletableFuture; |
Madan Jampani | ec5ae34 | 2015-04-13 15:43:10 -0700 | [diff] [blame^] | 20 | import java.util.concurrent.Executor; |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 21 | |
| 22 | /** |
| 23 | * Interface for low level messaging primitives. |
| 24 | */ |
| 25 | public interface MessagingService { |
| 26 | /** |
| 27 | * Sends a message asynchronously to the specified communication end point. |
| 28 | * The message is specified using the type and payload. |
| 29 | * @param ep end point to send the message to. |
| 30 | * @param type type of message. |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 31 | * @param payload message payload bytes. |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 32 | * @throws IOException when I/O exception of some sort has occurred |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 33 | */ |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 34 | public void sendAsync(Endpoint ep, String type, byte[] payload) throws IOException; |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 35 | |
| 36 | /** |
| 37 | * Sends a message synchronously and waits for a response. |
| 38 | * @param ep end point to send the message to. |
| 39 | * @param type type of message. |
| 40 | * @param payload message payload. |
| 41 | * @return a response future |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 42 | */ |
Madan Jampani | 2bfa94c | 2015-04-11 05:03:49 -0700 | [diff] [blame] | 43 | public CompletableFuture<byte[]> sendAndReceive(Endpoint ep, String type, byte[] payload); |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 44 | |
| 45 | /** |
| 46 | * Registers a new message handler for message type. |
| 47 | * @param type message type. |
| 48 | * @param handler message handler |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 49 | * @param executor executor to use for running message handler logic. |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 50 | */ |
Madan Jampani | ec5ae34 | 2015-04-13 15:43:10 -0700 | [diff] [blame^] | 51 | public void registerHandler(String type, MessageHandler handler, Executor executor); |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 52 | |
| 53 | /** |
| 54 | * Registers a new message handler for message type. |
| 55 | * @param type message type. |
| 56 | * @param handler message handler |
| 57 | */ |
| 58 | @Deprecated |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 59 | public void registerHandler(String type, MessageHandler handler); |
| 60 | |
| 61 | /** |
| 62 | * Unregister current handler, if one exists for message type. |
| 63 | * @param type message type |
| 64 | */ |
| 65 | public void unregisterHandler(String type); |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 66 | } |