summaryrefslogtreecommitdiffstats
path: root/framework/src/onos/core/api/src/main/java/org/onosproject/ui/UiConnection.java
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/ui/UiConnection.java')
-rw-r--r--framework/src/onos/core/api/src/main/java/org/onosproject/ui/UiConnection.java42
1 files changed, 42 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/ui/UiConnection.java b/framework/src/onos/core/api/src/main/java/org/onosproject/ui/UiConnection.java
new file mode 100644
index 00000000..ead7b0dc
--- /dev/null
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/ui/UiConnection.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * 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 org.onosproject.ui;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+
+/**
+ * Abstraction of a user interface session connection.
+ */
+public interface UiConnection {
+
+ /**
+ * Sends the specified JSON message to the user interface client.
+ *
+ * @param message message to send
+ */
+ void sendMessage(ObjectNode message);
+
+ /**
+ * Composes a message into JSON and sends it to the user interface client.
+ *
+ * @param type message type
+ * @param sid message sequence number
+ * @param payload message payload
+ */
+ // TODO: remove sid parameter
+ void sendMessage(String type, long sid, ObjectNode payload);
+
+} \ No newline at end of file