usnic_transport.h 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. /*
  2. * Copyright (c) 2013, Cisco Systems, Inc. All rights reserved.
  3. *
  4. * This software is available to you under a choice of one of two
  5. * licenses. You may choose to be licensed under the terms of the GNU
  6. * General Public License (GPL) Version 2, available from the file
  7. * COPYING in the main directory of this source tree, or the
  8. * BSD license below:
  9. *
  10. * Redistribution and use in source and binary forms, with or
  11. * without modification, are permitted provided that the following
  12. * conditions are met:
  13. *
  14. * - Redistributions of source code must retain the above
  15. * copyright notice, this list of conditions and the following
  16. * disclaimer.
  17. *
  18. * - Redistributions in binary form must reproduce the above
  19. * copyright notice, this list of conditions and the following
  20. * disclaimer in the documentation and/or other materials
  21. * provided with the distribution.
  22. *
  23. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27. * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28. * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30. * SOFTWARE.
  31. *
  32. */
  33. #ifndef USNIC_TRANSPORT_H_
  34. #define USNIC_TRANSPORT_H_
  35. #include "usnic_abi.h"
  36. const char *usnic_transport_to_str(enum usnic_transport_type trans_type);
  37. /*
  38. * Returns number of bytes written, excluding null terminator. If
  39. * nothing was written, the function returns 0.
  40. */
  41. int usnic_transport_sock_to_str(char *buf, int buf_sz,
  42. struct socket *sock);
  43. /*
  44. * Reserve a port. If "port_num" is set, then the function will try
  45. * to reserve that particular port.
  46. */
  47. u16 usnic_transport_rsrv_port(enum usnic_transport_type type, u16 port_num);
  48. void usnic_transport_unrsrv_port(enum usnic_transport_type type, u16 port_num);
  49. /*
  50. * Do a fget on the socket refered to by sock_fd and returns the socket.
  51. * Socket will not be destroyed before usnic_transport_put_socket has
  52. * been called.
  53. */
  54. struct socket *usnic_transport_get_socket(int sock_fd);
  55. void usnic_transport_put_socket(struct socket *sock);
  56. /*
  57. * Call usnic_transport_get_socket before calling *_sock_get_addr
  58. */
  59. int usnic_transport_sock_get_addr(struct socket *sock, int *proto,
  60. uint32_t *addr, uint16_t *port);
  61. int usnic_transport_init(void);
  62. void usnic_transport_fini(void);
  63. #endif /* !USNIC_TRANSPORT_H */