kmp_socket_if.h

00001 /*
00002  * Copyright (c) 2016-2019, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 #ifndef KMP_SOCKET_IF_H_
00019 #define KMP_SOCKET_IF_H_
00020 
00021 /*
00022  * Authenticator KMP socket interface to/from EAPOL authenticator relay. EAPOL
00023  * authenticator relay address and port are provided in register call (remote
00024  * address and remote port parameters)
00025  *
00026  * Authenticator KMP socket must be bound to port that EAPOL authenticator
00027  * uses to send messages to Authenticator KMP. Default port is 10254 (local port
00028  * parameter)
00029  *
00030  */
00031 
00032 /**
00033  * kmp_socket_if_register register socket interface to KMP service
00034  *
00035  * \param service KMP service to register to
00036  * \param local_port local port
00037  * \param remote_addr remote address
00038  * \param remote_port remote port
00039  *
00040  * \return < 0 failure
00041  * \return >= 0 success
00042  *
00043  */
00044 int8_t kmp_socket_if_register(kmp_service_t *service, uint16_t local_port, const uint8_t *remote_addr, uint16_t remote_port);
00045 
00046 /**
00047  * kmp_socket_if_unregister unregister socket interface from KMP service
00048  *
00049  * \param service KMP service to unregister from
00050  *
00051  * \return < 0 failure
00052  * \return >= 0 success
00053  *
00054  */
00055 int8_t kmp_socket_if_unregister(kmp_service_t *service);
00056 
00057 #endif /* KMP_SOCKET_IF_H_ */