/**

 * @file unicast_client.h

 * @brief Unicast client implementation

 * @note Copyright (C) 2018 Richard Cochran <richardcochran@gmail.com>

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License along

 * with this program; if not, write to the Free Software Foundation, Inc.,

 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA.

 */

#ifndef HAVE_UNICAST_CLIENT_H

#define HAVE_UNICAST_CLIENT_H

/**

 * Handles a CANCEL_UNICAST_TRANSMISSION TLV from the grantor.

 * @param p      The port on which the signaling message was received.

 * @param m      The signaling message containing the cancellation.

 * @param extra  The TLV containing the cancellation.

 * @return       Zero on success, or non-zero

 *               if transmission of the ACK message failed.

 */

int unicast_client_cancel(struct port *p, struct ptp_message *m,

			  struct tlv_extra *extra);

/**

 * Finds and initializes the unicast master table configured for this

 * port, if any.

 * @param port   The port in question.

 * @return       Zero on success, non-zero otherwise.

 */

int unicast_client_claim_table(struct port *port);

/**

 * Tests whether a unicast master table is associated with a given port.

 * @param p      The port in question.

 * @return       One (1) if a unicast master table is configured on the port,

 *               or zero otherwise.

 */

int unicast_client_enabled(struct port *p);

/**

 * Handles a GRANT_UNICAST_TRANSMISSION TLV from the grantor.

 * @param p      The port on which the signaling message was received.

 * @param m      The signaling message containing the grant.

 * @param extra  The TLV containing the grant.

 */

void unicast_client_grant(struct port *p, struct ptp_message *m,

			  struct tlv_extra *extra);

/**

 * Programs the unicast request timer.

 * @param p      The port in question.

 * @return       Zero on success, non-zero otherwise.

 */

int unicast_client_set_tmo(struct port *p);

/**

 * Notifies the unicast client code that the port state has changed.

 * @param p      The port in question.

 */

void unicast_client_state_changed(struct port *p);

/**

 * Handles the unicast request timer, sending requests as needed.

 * @param p      The port in question.

 * @return       Zero on success, non-zero otherwise.

 */

int unicast_client_timer(struct port *p);

#endif