Signaling Implementation

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "source/dependency/coreJSON"]
+	path = source/dependency/coreJSON
+	url = https://github.com/FreeRTOS/coreJSON
+	update = none

CMakeLists.txt

@@ -0,0 +1,32 @@
+cmake_minimum_required(VERSION 3.6.3)
+project(kvssignaling C)
+
+find_library(COREJSON_LIBRARY NAMES corejson ${coreJSON} REQUIRED)
+
+include(signalingFilePaths.cmake)
+
+if(BUILD_SHARED_LIBS)
+    add_library(kvssignaling SHARED ${SIGNALING_SOURCES})
+else()
+    add_library(kvssignaling STATIC ${SIGNALING_SOURCES})
+endif()
+
+target_include_directories(kvssignaling PUBLIC
+                           ${SIGNALING_INCLUDE_PUBLIC_DIRS}
+                           ${COREJSON_INCLUDE_DIRS})
+
+set_target_properties(kvssignaling PROPERTIES
+                      INSTALL_RPATH "${CMAKE_INSTALL_LIBDIR}"
+                      INSTALL_RPATH_USE_LINK_PATH TRUE)
+target_link_libraries(kvssignaling PRIVATE ${COREJSON_LIBRARY})
+
+# install header files
+install(
+    FILES ${SIGNALING_INCLUDE_PUBLIC_FILES}
+    DESTINATION include/kvssignaling)
+
+install(
+    TARGETS kvssignaling
+    ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}"
+    LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}"
+    RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}")

README.md

@@ -1,17 +1,36 @@
-## My Project
-
-TODO: Fill this README out!
-
-Be sure to:
-
-* Change the title in this README
-* Edit your repository description on GitHub
-
-## Security
-
-See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+## amazon-kinesis-video-streams-signaling
+
+The goal of the Signaling library is to enable control plane communication
+with the Amazon Kinesis Video Streams (KVS) service. Refer to
+[AWS KVS API Reference](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_Reference.html)
+and [WebRTC Websocket APIs](https://docs.aws.amazon.com/kinesisvideostreams-webrtc-dg/latest/devguide/kvswebrtc-websocket-apis.html)
+for more details.
+
+## What is Signaling?
+
+The Amazon Kinesis Video Signaling Service facilitates peer-to-peer
+communication by providing signaling channels that enable applications to
+discover, establish, control, and terminate connections through the exchange of
+signaling messages. This library provides APIs to construct requests to send to
+the Signaling Service and to parse responses from the Signaling Service.
+
+- Note that this library has a dependency on [coreJSON](https://github.com/FreeRTOS/coreJSON).
+
+## Using the library
+
+1. Use the `Signaling_Construct*` APIs to construct requests to send to the
+   Signaling Service.
+    - Ensure authenticate to sign the constructed requests using the Signature
+      Version 4 (SigV4) [authentication flow](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html)
+      before sending them.
+3. Use the `Signaling_Parse*` APIs to parse the responses from the Signaling
+   Service.
+4. Use `Signaling_ConstructWssMessage` and `Signaling_ParseWssRecvMessage` APIs
+   to communicate with the WSS endpoint.
+    - Ensure to authenticate and sign the constructed messages using the
+      Signature Version 4 (SigV4) [authentication flow](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html)
+      before sending them.
 
 ## License
 
 This project is licensed under the Apache-2.0 License.
-

signalingFilePaths.cmake

@@ -0,0 +1,19 @@
+# This file is to add source files and include directories
+# into variables so that it can be reused from different repositories
+# in their Cmake based build system by including this file.
+#
+# Files specific to the repository such as test runner, platform tests
+# are not added to the variables.
+
+# Signaling library source files.
+set( SIGNALING_SOURCES
+     "${CMAKE_CURRENT_LIST_DIR}/source/signaling_api.c" )
+
+# Signaling library Public Include directories.
+set( SIGNALING_INCLUDE_PUBLIC_DIRS
+     "${CMAKE_CURRENT_LIST_DIR}/source/include" )
+
+# Signaling library public include header files.
+set( SIGNALING_INCLUDE_PUBLIC_FILES
+     "${CMAKE_CURRENT_LIST_DIR}/source/include/signaling_api.h"
+     "${CMAKE_CURRENT_LIST_DIR}/source/include/signaling_data_types.h" )