Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 2.26 KB

ulink.adoc

File metadata and controls

53 lines (36 loc) · 2.26 KB
Raw

uLink Library & APIs

Table of Contents

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in IETF BCP14 (RFC2119 & RFC8174)

Copyright (c) 2023 General Motors GTO LLC

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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.

SPDX-FileType: DOCUMENTATION
SPDX-FileCopyrightText: 2023 General Motors GTO LLC
SPDX-License-Identifier: Apache-2.0

1. Overview

uLink refers to a library and boundary object used by all uEs (apps, services, core uEs, etc…​) to communicate with each other on a given uPlatform. The library contains a transport specific implementation of the uTransport and RpcClient interfaces. The library is language specific so there is a new library per supported uProtocol SDK Libraries.

2. Requirements

2.1. uLink Library

  • MUST contain a boundary object called ULink

  • MUST be language specific (one library per language)

2.2. Boundary Object

Below are the requirements for the ULink boundary object.

  • MUST implement the uTransport interface

  • MUST implement the RpcClient interface

  • MUST be named ULink

  • MUST NOT be more than one instance of ULink per URI addressable uE, this is because the protocol only can address at the uE name level. This is due to the fact uProtocol address is a singleton as the UUri can only address at the uE level .