arm_uc_socket_help.h

00001 // ----------------------------------------------------------------------------
00002 // Copyright 2016-2017 ARM Ltd.
00003 //
00004 // SPDX-License-Identifier: Apache-2.0
00005 //
00006 // Licensed under the Apache License, Version 2.0 (the "License");
00007 // you may not use this file except in compliance with the License.
00008 // You may obtain a copy of the License at
00009 //
00010 //     http://www.apache.org/licenses/LICENSE-2.0
00011 //
00012 // Unless required by applicable law or agreed to in writing, software
00013 // distributed under the License is distributed on an "AS IS" BASIS,
00014 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00015 // See the License for the specific language governing permissions and
00016 // limitations under the License.
00017 // ----------------------------------------------------------------------------
00018 
00019 #ifndef __ARM_UC_SOCKET_HELP_H__
00020 #define __ARM_UC_SOCKET_HELP_H__
00021 
00022 #include "update-client-common/arm_uc_common.h"
00023 
00024 #include <stdbool.h>
00025 #include <stdint.h>
00026 
00027 /**
00028  * @brief Helper function for picking out values from an HTTP header.
00029  * @details The buffer is searched for the tag provided tag and if found the
00030  *          remainder of that line is MOVED to the front of the buffer and the
00031  *          size is shrunk to only include the detected value.
00032  *
00033  * @param buffer Pointer to an arm_uc_buffer_t.
00034  * @param tag_buffer Pointer to tag (a string).
00035  * @param tag_size Length of the tag.
00036  * @return True if tag was found. False otherwise.
00037  */
00038 bool arm_uc_socket_trim_value(arm_uc_buffer_t* buffer,
00039                               const char* tag_buffer,
00040                               uint32_t tag_size);
00041 
00042 #endif // __ARM_UC_SOCKET_HELP_H__