thread_dhcpv6_server.h

00001 /*
00002  * Copyright (c) 2014-2015 ARM Limited. All rights reserved.
00003  *
00004  * SPDX-License-Identifier: LicenseRef-PBL
00005  *
00006  * Licensed under the Permissive Binary License, Version 1.0 (the "License"); you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  * https://www.mbed.com/licenses/PBL-1.0
00010  *
00011  * See the License for the specific language governing permissions and limitations under the License.
00012  *
00013  */
00014 
00015 /**
00016  * \file thread_dhcpv6_server.h
00017  * \brief Thread specific DHCP server.
00018  *
00019  * \warning This api will be removed as there is no Thread specific modifications anymore.
00020  */
00021 
00022 #ifndef THREAD_DHCPV6_SERVER_H_
00023 #define THREAD_DHCPV6_SERVER_H_
00024 
00025 #include "ns_types.h"
00026 
00027 /**
00028  * Set DHCPV6 server for Thread GP data purpose
00029  *
00030  * \param interface_id Network Interface
00031  * \param prefix_ptr pointer DHCPv6 Server Given Prefix
00032  *
00033  * \return 0, Set OK
00034  * \return <0 Set Not OK
00035  */
00036 int thread_dhcpv6_server_add(int8_t interface_id, uint8_t *prefix_ptr, uint16_t max_client_cnt, bool stableData);
00037 
00038 /**
00039  * Modify dhcp address valid lifetime values default value is 1 day (86400)
00040  *
00041  * \param interface_id Network Interface
00042  * \param prefix_ptr pointer DHCPv6 Server Given Prefix (size must be 16 bytes)
00043  * \param valid_lifetime New valid life value given to new address valid values are (120 - 0xffffffff)
00044  *
00045  * \return 0, ADD OK
00046  * \return <0 Add Not OK
00047  */
00048 int thread_dhcpv6_server_set_lifetime(int8_t interface_id, uint8_t *prefix_ptr, uint32_t valid_lifetime);
00049 
00050 /**
00051  * Modify dhcp maximum client count.
00052  *
00053  * \param interface_id Network Interface
00054  * \param prefix_ptr pointer DHCPv6 Server Given Prefix  (size must be 16 bytes)
00055  * \param max_client_count maximum amount of clients valid values (1 - 0xffffffff)
00056  *
00057  * \return 0, ADD OK
00058  * \return <0 Add Not OK
00059  */
00060 int thread_dhcpv6_server_set_max_client(int8_t interface_id, uint8_t *prefix_ptr, uint32_t max_client_count);
00061 
00062 /**
00063  * Modify dhcp anonymous mode.
00064  *
00065  * \param interface_id Network Interface
00066  * \param prefix_ptr pointer DHCPv6 Server Given Prefix  (size must be 16 bytes)
00067  * \param anonymous true == addressing mode is anonymous, false == addressing mode uses mac address after prefix.
00068  *
00069  * \return 0, ADD OK
00070  * \return <0 Add Not OK
00071  */
00072 int thread_dhcpv6_server_set_anonymous_addressing(int8_t interface_id, uint8_t *prefix_ptr, bool anonymous);
00073 
00074 /**
00075  * Stop DHCPV6 server for Thread GP data purpose
00076  *
00077  * \param interface_id Network Interface
00078  * \param prefix_ptr pointer DHCPv6 Server Given Prefix
00079  *
00080  * \return 0, Stop OK
00081  * \return <0 Stop Not OK
00082  */
00083 int thread_dhcpv6_server_delete(int8_t interface_id, uint8_t *prefix_ptr);
00084 
00085 #endif /* THREAD_DHCPV6_SERVER_H_ */