Sat Apr 26 2014 22:02:57

Asterisk developer's documentation


netsock.h File Reference

Network socket handling. More...

#include "asterisk/network.h"
#include "asterisk/io.h"
#include "asterisk/netsock2.h"
Include dependency graph for netsock.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

struct ast_netsockast_netsock_bind (struct ast_netsock_list *list, struct io_context *ioc, const char *bindinfo, int defaultport, int tos, int cos, ast_io_cb callback, void *data)
struct ast_netsockast_netsock_bindaddr (struct ast_netsock_list *list, struct io_context *ioc, struct ast_sockaddr *bindaddr, int tos, int cos, ast_io_cb callback, void *data)
struct ast_sockaddrast_netsock_boundaddr (const struct ast_netsock *ns)
void * ast_netsock_data (const struct ast_netsock *ns)
struct ast_netsockast_netsock_find (struct ast_netsock_list *list, struct ast_sockaddr *addr)
int ast_netsock_init (struct ast_netsock_list *list)
struct ast_netsock_listast_netsock_list_alloc (void)
int ast_netsock_release (struct ast_netsock_list *list)
int ast_netsock_set_qos (int sockfd, int tos, int cos, const char *desc)
int ast_netsock_sockfd (const struct ast_netsock *ns)
void ast_netsock_unref (struct ast_netsock *ns)

Detailed Description

Network socket handling.

Definition in file netsock.h.


Function Documentation

struct ast_netsock* ast_netsock_bind ( struct ast_netsock_list list,
struct io_context ioc,
const char *  bindinfo,
int  defaultport,
int  tos,
int  cos,
ast_io_cb  callback,
void *  data 
) [read]

Definition at line 169 of file netsock.c.

References ast_log(), ast_netsock_bindaddr(), ast_sockaddr_is_ipv4(), ast_sockaddr_parse(), ast_sockaddr_port, ast_sockaddr_set_port, and LOG_WARNING.

Referenced by peer_set_srcaddr(), and set_config().

{
   struct ast_sockaddr addr;

   if (ast_sockaddr_parse(&addr, bindinfo, 0)) {
      if (!ast_sockaddr_is_ipv4(&addr)) {
         ast_log(LOG_WARNING, "Only IPv4 addresses are supported at this time.\n");
         return NULL;
      }

      if (!ast_sockaddr_port(&addr)) {
         ast_sockaddr_set_port(&addr, defaultport);
      }

      return ast_netsock_bindaddr(list, ioc, &addr, tos, cos, callback, data);
   }

   return NULL;
}
struct ast_netsock* ast_netsock_bindaddr ( struct ast_netsock_list list,
struct io_context ioc,
struct ast_sockaddr bindaddr,
int  tos,
int  cos,
ast_io_cb  callback,
void *  data 
) [read]

Definition at line 111 of file netsock.c.

References ast_bind(), ast_calloc, ast_enable_packet_fragmentation(), ast_free, ast_io_add(), AST_IO_IN, ast_log(), ast_set_qos(), ast_sockaddr_stringify(), ASTOBJ_CONTAINER_LINK, ASTOBJ_INIT, ast_netsock::bindaddr, ast_netsock::data, errno, ast_netsock::ioc, ast_netsock::ioref, LOG_ERROR, LOG_WARNING, netsocket, and ast_netsock::sockfd.

Referenced by ast_netsock_bind().

{
   int netsocket = -1;
   int *ioref;

   struct ast_netsock *ns;
   const int reuseFlag = 1;

   /* Make a UDP socket */
   netsocket = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP);

   if (netsocket < 0) {
      ast_log(LOG_ERROR, "Unable to create network socket: %s\n", strerror(errno));
      return NULL;
   }
   if (setsockopt(netsocket, SOL_SOCKET, SO_REUSEADDR, (char *)&reuseFlag, sizeof reuseFlag) < 0) {
      ast_log(LOG_WARNING, "Error setting SO_REUSEADDR on sockfd '%d'\n", netsocket);
   }
   if (ast_bind(netsocket, bindaddr)) {
      ast_log(LOG_ERROR,
         "Unable to bind to %s: %s\n",
         ast_sockaddr_stringify(bindaddr),
         strerror(errno));
      close(netsocket);
      return NULL;
   }

   ast_set_qos(netsocket, tos, cos, "IAX2");

   ast_enable_packet_fragmentation(netsocket);

   if (!(ns = ast_calloc(1, sizeof(*ns)))) {
      close(netsocket);
      return NULL;
   }

   /* Establish I/O callback for socket read */
   if (!(ioref = ast_io_add(ioc, netsocket, callback, AST_IO_IN, ns))) {
      close(netsocket);
      ast_free(ns);
      return NULL;
   }
   ASTOBJ_INIT(ns);
   ns->ioref = ioref;
   ns->ioc = ioc;
   ns->sockfd = netsocket;
   ns->data = data;
   memcpy(&ns->bindaddr, bindaddr, sizeof(ns->bindaddr));
   ASTOBJ_CONTAINER_LINK(list, ns);

   return ns;
}
struct ast_sockaddr* ast_netsock_boundaddr ( const struct ast_netsock ns) [read]

Definition at line 194 of file netsock.c.

References ast_netsock::bindaddr.

{
   return &ns->bindaddr;
}
void* ast_netsock_data ( const struct ast_netsock ns)

Definition at line 199 of file netsock.c.

References ast_netsock::data.

{
   return ns->data;
}
struct ast_netsock* ast_netsock_find ( struct ast_netsock_list list,
struct ast_sockaddr addr 
) [read]

Definition at line 96 of file netsock.c.

References ast_sockaddr_cmp(), ASTOBJ_CONTAINER_TRAVERSE, ASTOBJ_RDLOCK, and ASTOBJ_UNLOCK.

Referenced by peer_set_srcaddr().

{
   struct ast_netsock *sock = NULL;

   ASTOBJ_CONTAINER_TRAVERSE(list, !sock, {
      ASTOBJ_RDLOCK(iterator);
      if (!ast_sockaddr_cmp(&iterator->bindaddr, addr)) {
         sock = iterator;
      }
      ASTOBJ_UNLOCK(iterator);
   });

   return sock;
}
int ast_netsock_init ( struct ast_netsock_list list)

Definition at line 79 of file netsock.c.

References ASTOBJ_CONTAINER_INIT.

Referenced by load_module(), and set_config().

{
   memset(list, 0, sizeof(*list));
   ASTOBJ_CONTAINER_INIT(list);

   return 0;
}
struct ast_netsock_list* ast_netsock_list_alloc ( void  ) [read]

Definition at line 74 of file netsock.c.

References ast_calloc.

Referenced by load_module(), and set_config().

{
   return ast_calloc(1, sizeof(struct ast_netsock_list));
}
int ast_netsock_set_qos ( int  sockfd,
int  tos,
int  cos,
const char *  desc 
)
Deprecated:
Use ast_seq_qos in netsock2.h which properly handles IPv4 and IPv6 sockets, instead.

Definition at line 164 of file netsock.c.

References ast_set_qos().

{
   return ast_set_qos(sockfd, tos, cos, desc);
}
int ast_netsock_sockfd ( const struct ast_netsock ns)

Definition at line 189 of file netsock.c.

Referenced by peer_set_srcaddr(), and set_config().

{
   return ns ? ns-> sockfd : -1;
}
void ast_netsock_unref ( struct ast_netsock ns)

Definition at line 204 of file netsock.c.

References ast_netsock_destroy(), and ASTOBJ_UNREF.

Referenced by peer_set_srcaddr(), and set_config().