src/messaging/README

   1
   2 ==================================================================================
   3        Copyright (c) 2020 Nokia
   4        Copyright (c) 2020 AT&T Intellectual Property.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    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, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18
  19 This directory contains the source for the RMR messaging portion of the
  20 framework.  Specifially:
  21
  22         message.*
  23                 provides a message class from which the user can extract/set information
  24                 (type, subscription ID, payload, etc.) and provides instance funcitons
  25                 for sending and replying to the message. User programmes will interact
  26                 directly with this.
  27
  28         msg_component.*
  29                 This is a small type def that allows some of the getter functions in message
  30                 to return a smart pointer to memory which cannot directly be released (e.g
  31                 the payload).   This allows the user programme to declare a variable of type
  32                 Msg_component (which is really a smart pointer with a custom deleter) rather
  33                 than having to understand the needed smart pointer construct for these things.
  34
  35         messenger.*
  36                 This class provides the direct "wrapper" on top of RMR. It supports
  37                 high level operations such as Listen and callback management.
  38
  39         callback.*
  40                 This provides the callback support to messenger (listen) functions.
  41
  42         default_cb.*
  43                 This module contains any default callback functions which are provided
  44                 by the framework (e.g. health check processing).
  45
  46
  47