inc/messages/message_config_user_name.h

   1 /*
   2  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Flora License, Version 1.1 (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
   7  *
   8  * http://floralicense.org/license/
   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.
  15  */
  16
  17 #ifndef MESSAGE_CONFIG_USER_NAME_H
  18 #define MESSAGE_CONFIG_USER_NAME_H
  19
  20 #include "messages/message.h"
  21
  22 /**
  23  * @brief Config user name message data
  24  */
  25 typedef struct message_config_user_name {
  26         message_t base;        /** Base class */
  27         char *user_name; /** User name */
  28 } message_config_user_name_t;
  29
  30 /**
  31  * @brief Initializes message_config_user_name_t object.
  32  *
  33  * @param[in] message config user name message.
  34  */
  35 void message_config_user_name_init(message_config_user_name_t *message);
  36
  37 /**
  38  * @brief Get name from mesage.
  39  *
  40  * @param[in] message config user name message.
  41  *
  42  * @return Const pointer to name.
  43  */
  44 const char *message_config_user_name_get_name(message_config_user_name_t *message);
  45
  46 /**
  47  * @brief Set name for message.
  48  *
  49  * @param[in] message config user name message.
  50  * @param[in] name name to be set.
  51  */
  52 void message_config_user_name_set_name(message_config_user_name_t *message, const char *name);
  53
  54 /**
  55  * @brief Destroys message_config_user_name_t object.
  56  *
  57  * @param[in] message message.
  58  */
  59 void message_config_user_name_destroy(message_config_user_name_t *message);
  60
  61 /**
  62  * @brief Deserializes message_config_user_name_t from reader's buffer.
  63  *
  64  * @param[in] message config user name message.
  65  * @param[in] reader reader object.
  66  *
  67  * @return 0 on success, other value on failure.
  68  */
  69 int message_config_user_name_deserialize(message_config_user_name_t *message, reader_t *reader);
  70
  71 /**
  72  * @brief Serializes message_config_user_name_t into writer's buffer.
  73  *
  74  * @param[in] message config user name message.
  75  * @param[in] writer writer object.
  76  *
  77  * @return 0 on success, other value on failure.
  78  */
  79 int message_config_user_name_serialize(message_config_user_name_t *message, writer_t *writer);
  80
  81 #endif /* end of include guard: MESSAGE_CONFIG_USER_NAME_H */