gst/dccp/: CodeStyle improvements and minor fixes to the DCCP plugin.
authorLeandro Melo de Sales <leandroal@gmail.com>
Thu, 20 Nov 2008 16:01:27 +0000 (16:01 +0000)
committerStefan Kost <ensonic@users.sourceforge.net>
Thu, 20 Nov 2008 16:01:27 +0000 (16:01 +0000)
Original commit message from CVS:
patch by: Leandro Melo de Sales <leandroal@gmail.com>
* gst/dccp/gstdccp.c:
* gst/dccp/gstdccp.h:
* gst/dccp/gstdccpclientsink.c:
* gst/dccp/gstdccpclientsink.h:
* gst/dccp/gstdccpclientsrc.c:
* gst/dccp/gstdccpserversink.c:
* gst/dccp/gstdccpserversrc.c:
* gst/dccp/gstdccpserversrc.h:
CodeStyle improvements and minor fixes to the DCCP plugin.
Fixes #553823.

ChangeLog
gst/dccp/gstdccp.c
gst/dccp/gstdccp.h
gst/dccp/gstdccpclientsink.c
gst/dccp/gstdccpclientsink.h
gst/dccp/gstdccpclientsrc.c
gst/dccp/gstdccpserversink.c
gst/dccp/gstdccpserversrc.c
gst/dccp/gstdccpserversrc.h

index 86db113fe8a6f9be55376d879635e95f7f29757d..e253a2ead9915e2fbe1d988940e584bf22a2c767 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,18 @@
+2008-11-20  Stefan Kost  <ensonic@users.sf.net>
+
+       patch by: Leandro Melo de Sales <leandroal@gmail.com>
+
+       * gst/dccp/gstdccp.c:
+       * gst/dccp/gstdccp.h:
+       * gst/dccp/gstdccpclientsink.c:
+       * gst/dccp/gstdccpclientsink.h:
+       * gst/dccp/gstdccpclientsrc.c:
+       * gst/dccp/gstdccpserversink.c:
+       * gst/dccp/gstdccpserversrc.c:
+       * gst/dccp/gstdccpserversrc.h:
+         CodeStyle improvements and minor fixes to the DCCP plugin.
+         Fixes #553823.
+
 2008-11-20  Sebastian Dröge  <slomo@circular-chaos.org>
 
        * gst/rtpmanager/gstrtpjitterbuffer.c:
index 8a4f02df65c20881c24bcd7a8651f29876f5cc99..c9c100e72699b5cd267e75d3281c8795feadaa8e 100644 (file)
 #endif
 
 /* Prototypes and definitions for private functions and not exported via gstdccp.h */
-gint gst_dccp_socket_write (int socket, const void *buf, size_t count,
-    int packet_size);
-gboolean gst_dccp_socket_connected (GstElement * element, int server_sock_fd);
+GstFlowReturn gst_dccp_socket_write (GstElement * element, int socket,
+    const void *buf, size_t count, int packet_size);
 struct sockaddr_in gst_dccp_create_sockaddr (GstElement * element, gchar * ip,
     int port);
 
-/* Resolves host to IP address
- * @return a gchar pointer containing the ip address or NULL
+/*
+ * Resolves host to IP address
+ * @param element - the element
+ * @return a gchar pointer containing the ip address or NULL if it
+ * couldn't resolve the host to a IP adress
  */
 gchar *
 gst_dccp_host_to_ip (GstElement * element, const gchar * host)
@@ -83,10 +85,15 @@ gst_dccp_host_to_ip (GstElement * element, const gchar * host)
   return ip;
 }
 
-/* Read a buffer from the given socket
- * @returns:
- *   a GstBuffer from which data should be read
- *   or NULL, indicating a connection close or an error. Handle it with EOS.
+/*
+ * Read a buffer from the given socket
+ *
+ * @param this - the element that has the socket that will be read
+ * @param socket - the socket fd that will be read
+ * @param buf - the buffer with the data read from the socket
+ * @return GST_FLOW_OK if the read operation was successful
+ * or GST_FLOW_ERROR indicating a connection close or an error.
+ * Handle it with EOS.
  */
 GstFlowReturn
 gst_dccp_read_buffer (GstElement * this, int socket, GstBuffer ** buf)
@@ -96,6 +103,8 @@ gst_dccp_read_buffer (GstElement * this, int socket, GstBuffer ** buf)
   int ret;
   ssize_t bytes_read;
   int readsize;
+  struct msghdr mh;
+  struct iovec iov;
 
   *buf = NULL;
 
@@ -124,7 +133,23 @@ gst_dccp_read_buffer (GstElement * this, int socket, GstBuffer ** buf)
   }
 
   *buf = gst_buffer_new_and_alloc (readsize);
-  bytes_read = read (socket, GST_BUFFER_DATA (*buf), readsize);
+
+  memset (&mh, 0, sizeof (mh));
+  mh.msg_name = NULL;
+  mh.msg_namelen = 0;
+  iov.iov_base = GST_BUFFER_DATA (*buf);
+  iov.iov_len = readsize;
+  mh.msg_iov = &iov;
+  mh.msg_iovlen = 1;
+  mh.msg_control = NULL;
+  mh.msg_controllen = 0;
+
+  bytes_read = recvmsg (socket, &mh, 0);
+
+  if (bytes_read != readsize) {
+    GST_DEBUG_OBJECT (this, ("Error while reading data"));
+    return GST_FLOW_ERROR;
+  }
 
   GST_LOG_OBJECT (this, "bytes read %" G_GSIZE_FORMAT, bytes_read);
   GST_LOG_OBJECT (this, "returning buffer of size %d", GST_BUFFER_SIZE (*buf));
@@ -132,7 +157,9 @@ gst_dccp_read_buffer (GstElement * this, int socket, GstBuffer ** buf)
   return GST_FLOW_OK;
 }
 
-/* Create a new socket
+/* Create a new DCCP socket
+ *
+ * @param element - the element
  * @return the socket file descriptor
  */
 gint
@@ -147,7 +174,10 @@ gst_dccp_create_new_socket (GstElement * element)
 }
 
 /* Connect to a server
- * @return true in case of successfull connection, false otherwise
+ * @param element - the element
+ * @param server_sin - a struct with a server address and port
+ * @param sock_fd - the socket to connect
+ * @return TRUE in case of successful connection, FALSE otherwise
  */
 gboolean
 gst_dccp_connect_to_server (GstElement * element, struct sockaddr_in server_sin,
@@ -158,11 +188,15 @@ gst_dccp_connect_to_server (GstElement * element, struct sockaddr_in server_sin,
   if (connect (sock_fd, (struct sockaddr *) &server_sin, sizeof (server_sin))) {
     switch (errno) {
       case ECONNREFUSED:
-        GST_ERROR_OBJECT (element, "Connection refused.");
+        GST_ELEMENT_ERROR (element, RESOURCE, OPEN_WRITE,
+            ("Connection to %s:%d refused.", inet_ntoa (server_sin.sin_addr),
+                ntohs (server_sin.sin_port)), (NULL));
         return FALSE;
         break;
       default:
-        GST_ERROR_OBJECT (element, "Connection failed.");
+        GST_ELEMENT_ERROR (element, RESOURCE, OPEN_READ, (NULL),
+            ("Connect to %s:%d failed: %s", inet_ntoa (server_sin.sin_addr),
+                ntohs (server_sin.sin_port), g_strerror (errno)));
         return FALSE;
         break;
     }
@@ -173,6 +207,9 @@ gst_dccp_connect_to_server (GstElement * element, struct sockaddr_in server_sin,
 /* FIXME support only one client */
 /*
  * Accept connection on the server socket.
+ *
+ * @param element - the element
+ * @param server_sock_fd - the server socket file descriptor
  * @return the socket of the client connected to the server.
  */
 gint
@@ -183,29 +220,30 @@ gst_dccp_server_wait_connections (GstElement * element, int server_sock_fd)
   struct sockaddr_in client_address;
   unsigned int client_address_len;
 
-  /* For some stupid reason, client_address and client_address_len has to be
-   * zeroed */
   memset (&client_address, 0, sizeof (client_address));
   client_address_len = 0;
 
   if ((client_sock_fd =
           accept (server_sock_fd, (struct sockaddr *) &client_address,
               &client_address_len)) == -1) {
+    GST_ELEMENT_ERROR (element, RESOURCE, OPEN_WRITE, (NULL),
+        ("Could not accept client on server socket %d: %s (%d)",
+            server_sock_fd, g_strerror (errno), errno));
     return -1;
   }
-  /* to support multiple connection, fork here a new thread passing the
-   * client_sock_fd returned by accept function.
-   */
 
-  GST_DEBUG_OBJECT (element, "added new client ip %s with fd %d",
+  GST_DEBUG_OBJECT (element, "Added new client ip %s with fd %d.",
       inet_ntoa (client_address.sin_addr), client_sock_fd);
 
-  /* return the thread object, instead of the fd */
   return client_sock_fd;
 }
 
 /*
  * Bind a server address.
+ *
+ * @param element - the element
+ * @param server_sock_fd - the server socket fd
+ * @param server_sin - the address and the port to bind the server on
  * @return true in success, false otherwise.
  */
 gboolean
@@ -214,14 +252,15 @@ gst_dccp_bind_server_socket (GstElement * element, int server_sock_fd,
 {
   int ret;
 
-  GST_DEBUG_OBJECT (element, "binding server socket to address");
+  GST_DEBUG_OBJECT (element, "Binding server socket to address.");
+
   ret = bind (server_sock_fd, (struct sockaddr *) &server_sin,
       sizeof (server_sin));
   if (ret) {
     switch (errno) {
       default:
         GST_ELEMENT_ERROR (element, RESOURCE, OPEN_READ, (NULL),
-            ("bind on port %d failed: %s", server_sin.sin_port,
+            ("Bind on port %d failed: %s", ntohs (server_sin.sin_port),
                 g_strerror (errno)));
         return FALSE;
         break;
@@ -230,45 +269,65 @@ gst_dccp_bind_server_socket (GstElement * element, int server_sock_fd,
   return TRUE;
 }
 
+/*
+ * Listen on server socket.
+ *
+ * @param element - the element
+ * @param server_sock_fd - the server socket fd
+ * @return true in success, false otherwise.
+ */
 gboolean
 gst_dccp_listen_server_socket (GstElement * element, int server_sock_fd)
 {
 
-  GST_DEBUG_OBJECT (element, "listening on server socket %d with queue of %d",
+  GST_DEBUG_OBJECT (element, "Listening on server socket %d with queue of %d",
       server_sock_fd, DCCP_BACKLOG);
+
   if (listen (server_sock_fd, DCCP_BACKLOG) == -1) {
     GST_ELEMENT_ERROR (element, RESOURCE, OPEN_READ, (NULL),
         ("Could not listen on server socket: %s", g_strerror (errno)));
     return FALSE;
   }
+
   GST_DEBUG_OBJECT (element,
-      "listened on server socket %d, returning from connection setup",
+      "Listened on server socket %d, returning from connection setup",
       server_sock_fd);
 
   return TRUE;
 }
 
-/* FIXME */
-gboolean
-gst_dccp_socket_connected (GstElement * element, int server_sock_fd)
-{
-  return FALSE;
-}
-
 /* Write buffer to given socket incrementally.
- * Returns number of bytes written.
+ *
+ * @param element - the element
+ * @param socket - the socket
+ * @param buf - the buffer that will be written
+ * @param size - the number of bytes of the buffer
+ * @param packet_size - the MTU
+ * @return the number of bytes written.
  */
-gint
-gst_dccp_socket_write (int socket, const void *buf, size_t size,
-    int packet_size)
+GstFlowReturn
+gst_dccp_socket_write (GstElement * element, int socket, const void *buf,
+    size_t size, int packet_size)
 {
   size_t bytes_written = 0;
   ssize_t wrote;
 
+  struct iovec iov;
+  struct msghdr mh;
+  memset (&mh, 0, sizeof (mh));
+
   while (bytes_written < size) {
     do {
-      wrote = write (socket, (const char *) buf + bytes_written,
-          MIN (packet_size, size - bytes_written));
+      mh.msg_name = NULL;
+      mh.msg_namelen = 0;
+      iov.iov_base = (char *) buf + bytes_written;
+      iov.iov_len = MIN (packet_size, size - bytes_written);
+      mh.msg_iov = &iov;
+      mh.msg_iovlen = 1;
+      mh.msg_control = NULL;
+      mh.msg_controllen = 0;
+
+      wrote = sendmsg (socket, &mh, 0);
     } while (wrote == -1 && errno == EAGAIN);
 
     /* TODO print the send error */
@@ -276,17 +335,35 @@ gst_dccp_socket_write (int socket, const void *buf, size_t size,
   }
 
   if (bytes_written < 0)
-    GST_WARNING ("error while writing");
+    GST_WARNING ("Error while writing.");
   else
-    GST_LOG ("wrote %" G_GSIZE_FORMAT " bytes succesfully", bytes_written);
-  return bytes_written;
+    GST_LOG_OBJECT (element, "Wrote %" G_GSIZE_FORMAT " bytes succesfully.",
+        bytes_written);
+
+  if (bytes_written != size) {
+    GST_ELEMENT_ERROR (element, RESOURCE, WRITE,
+        ("Error while sending data to socket %d.", socket),
+        ("Only %" G_GSIZE_FORMAT " of %u bytes written: %s",
+            bytes_written, size, g_strerror (errno)));
+    return GST_FLOW_ERROR;
+  }
+
+  return GST_FLOW_OK;
 }
 
+/* Write buffer to given socket.
+ *
+ * @param this - the element
+ * @param buf - the buffer that will be written
+ * @param client_sock_fd - the client socket
+ * @param packet_size - the MTU
+ * @return GST_FLOW_OK if the send operation was successful, GST_FLOW_ERROR otherwise.
+ */
 GstFlowReturn
 gst_dccp_send_buffer (GstElement * this, GstBuffer * buffer, int client_sock_fd,
     int packet_size)
 {
-  size_t wrote;
+//  size_t wrote;
   gint size = 0;
   guint8 *data;
 
@@ -296,21 +373,17 @@ gst_dccp_send_buffer (GstElement * this, GstBuffer * buffer, int client_sock_fd,
   GST_LOG_OBJECT (this, "writing %d bytes", size);
 
   if (packet_size < 0) {
-    GST_LOG_OBJECT (this, "error getting MTU");
     return GST_FLOW_ERROR;
   }
 
-  wrote = gst_dccp_socket_write (client_sock_fd, data, size, packet_size);
-
-  if (wrote != size) {
-    GST_DEBUG_OBJECT (this, ("Error while sending data"));
-    return GST_FLOW_ERROR;
-  }
-  return GST_FLOW_OK;
+  return gst_dccp_socket_write (this, client_sock_fd, data, size, packet_size);
 }
 
 /*
  * Create socket address.
+ * @param element - the element
+ * @param ip - the ip address
+ * @param port - the port
  * @return sockaddr_in.
  */
 struct sockaddr_in
@@ -326,6 +399,12 @@ gst_dccp_create_sockaddr (GstElement * element, gchar * ip, int port)
   return sin;
 }
 
+/*
+ * Make address reusable.
+ * @param element - the element
+ * @param sock_fd - the socket
+ * @return TRUE if the operation was successful, FALSE otherwise.
+ */
 gboolean
 gst_dccp_make_address_reusable (GstElement * element, int sock_fd)
 {
@@ -340,7 +419,13 @@ gst_dccp_make_address_reusable (GstElement * element, int sock_fd)
   return TRUE;
 }
 
-/* DCCP socket specific stuffs */
+/*
+ * Set DCCP congestion control.
+ * @param element - the element
+ * @param sock_fd - the socket
+ * @param ccid - the ccid number
+ * @return TRUE if the operation was successful, FALSE otherwise.
+ */
 gboolean
 gst_dccp_set_ccid (GstElement * element, int sock_fd, uint8_t ccid)
 {
@@ -408,6 +493,12 @@ gst_dccp_get_ccid (GstElement * element, int sock_fd, int tx_or_rx)
   return ccid;
 }
 
+/*
+ * Get the socket MTU.
+ * @param element - the element
+ * @param sock - the socket
+ * @return the MTU if the operation was successful, -1 otherwise.
+ */
 gint
 gst_dccp_get_max_packet_size (GstElement * element, int sock)
 {
@@ -423,36 +514,12 @@ gst_dccp_get_max_packet_size (GstElement * element, int sock)
   return size;
 }
 
-/* Still not used and need to be FIXED */
-gboolean
-gst_dccp_set_sock_windowsize (GstElement * element, int sock, int winSize,
-    gboolean inSend)
+void
+gst_dccp_socket_close (GstElement * element, int *socket)
 {
-#ifdef SO_SNDBUF
-  int rc;
-
-  if (!inSend) {
-    /* receive buffer -- set
-     * note: results are verified after connect() or listen(),
-     * since some OS's don't show the corrected value until then. */
-    rc = setsockopt (sock, SOL_DCCP, SO_RCVBUF,
-        (char *) &winSize, sizeof (winSize));
-    GST_DEBUG_OBJECT (element, "set rcv sockbuf: %d", winSize);
-  } else {
-    /* send buffer -- set
-     * note: results are verified after connect() or listen(),
-     * since some OS's don't show the corrected value until then. */
-    rc = setsockopt (sock, SOL_DCCP, SO_SNDBUF,
-        (char *) &winSize, sizeof (winSize));
-    GST_DEBUG_OBJECT (element, "set snd sockbuf: %d", winSize);
+  if (socket >= 0) {
+    GST_DEBUG_OBJECT (element, "closing socket");
+    close (*socket);
+    *socket = -1;
   }
-
-  if (rc < 0) {
-    GST_ELEMENT_ERROR (element, RESOURCE, SETTINGS, (NULL),
-        ("Could not set window size %d: %s", errno, g_strerror (errno)));
-    return FALSE;
-  }
-#endif /* SO_SNDBUF */
-
-  return TRUE;
 }
index 117b0df50bc50236962dbf050141f98d07f444a6..f5aa2ccc537b71437d9d5ceaf9a40f067ef3a8e2 100644 (file)
@@ -90,7 +90,6 @@ GstFlowReturn gst_dccp_send_buffer (GstElement * element, GstBuffer * buffer,
                                        int client_sock_fd, int packet_size);
 
 gboolean gst_dccp_make_address_reusable (GstElement * element, int sock_fd);
-gboolean gst_dccp_set_sock_windowsize(GstElement * element, int sock, int winSize,
-                                                                                                                       gboolean inSend);
+void gst_dccp_socket_close (GstElement * element, int * socket);
 
 #endif /* __GST_DCCP_H__ */
index d8fca1fbd395e963429fba1ec46ecd618fee1675..348a0b87b9697a934f308ccc2b4727c5c28cc4a5 100644 (file)
@@ -96,6 +96,11 @@ GST_BOILERPLATE (GstDCCPClientSink, gst_dccp_client_sink, GstBaseSink,
 
 static guint gst_dccp_client_sink_signals[LAST_SIGNAL] = { 0 };
 
+/*
+ * Write buffer to client socket.
+ *
+ * @return GST_FLOW_OK if the send operation was successful, GST_FLOW_ERROR otherwise.
+ */
 static GstFlowReturn
 gst_dccp_client_sink_render (GstBaseSink * bsink, GstBuffer * buf)
 {
@@ -172,6 +177,13 @@ gst_dccp_client_sink_get_property (GObject * object, guint prop_id,
   }
 }
 
+/*
+ * Starts the element. If the sockfd property was not the default, this method
+ * will create a new socket and connect to the server.
+ *
+ * @param bsink - the element
+ * @return TRUE if the send operation was successful, FALSE otherwise.
+ */
 static gboolean
 gst_dccp_client_sink_start (GstBaseSink * bsink)
 {
@@ -250,10 +262,8 @@ gst_dccp_client_sink_stop (GstBaseSink * bsink)
 
   sink = GST_DCCP_CLIENT_SINK (bsink);
 
-  if (sink->sock_fd != -1 && sink->closed) {
-    GST_DEBUG_OBJECT (sink, "closing socket");
-    close (sink->sock_fd);
-    sink->sock_fd = -1;
+  if (sink->sock_fd != DCCP_DEFAULT_SOCK_FD && sink->closed) {
+    gst_dccp_socket_close (GST_ELEMENT (sink), &(sink->sock_fd));
   }
 
   return TRUE;
@@ -276,10 +286,9 @@ gst_dccp_client_sink_class_init (GstDCCPClientSinkClass * klass)
 
   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PORT,
       g_param_spec_int ("port", "Port",
-          "The port to receive the packets from, 0=allocate", 0, G_MAXUINT16,
+          "The port to send the packets to", 0, G_MAXUINT16,
           DCCP_DEFAULT_PORT, G_PARAM_READWRITE));
 
-/* FIXME property server_ip */
   g_object_class_install_property (gobject_class, PROP_HOST,
       g_param_spec_string ("host", "Host",
           "The host IP address to send packets to", DCCP_DEFAULT_HOST,
@@ -303,8 +312,8 @@ gst_dccp_client_sink_class_init (GstDCCPClientSinkClass * klass)
   /* signals */
   /**
    * GstDccpClientSink::connected:
-   * @sink: the gstdccpclientsink instance
-   * @fd: the connected socket fd
+   * @sink: the gstdccpclientsink element that emitted this signal
+   * @fd: the connected socket file descriptor
    *
    * Sign that the element has connected, return the fd of the socket.
    */
index 6af03b5f9a669f7b906045c28d5e4c73b72bd3c7..89f7d5e7c5fd624a00012acf8ad2bb14749c9037 100644 (file)
@@ -47,6 +47,11 @@ typedef struct _GstDCCPClientSink GstDCCPClientSink;
 typedef struct _GstDCCPClientSinkClass GstDCCPClientSinkClass;
 
 
+/**
+ * GstDCCPClientSink:
+ *
+ * dccpclientsink object structure.
+ */
 struct _GstDCCPClientSink
 {
   GstBaseSink element;
index f82bd17088c0164b9ba983d6534259e2012909f0..73f45eb326dfbb059e230ad30955e99958444655 100644 (file)
@@ -102,6 +102,11 @@ GST_BOILERPLATE (GstDCCPClientSrc, gst_dccp_client_src, GstPushSrc,
 
 static guint gst_dccp_client_src_signals[LAST_SIGNAL] = { 0 };
 
+/*
+ * Read a buffer from the client socket
+ *
+ * @return GST_FLOW_OK if the send operation was successful, GST_FLOW_ERROR otherwise.
+ */
 static GstFlowReturn
 gst_dccp_client_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
 {
@@ -220,6 +225,13 @@ gst_dccp_client_src_get_property (GObject * object, guint prop_id,
   }
 }
 
+/*
+ * Starts the element. If the sockfd property was not the default, this method
+ * will create a new socket and connect to the server.
+ *
+ * @param bsrc - the element
+ * @return TRUE if the send operation was successful, FALSE otherwise.
+ */
 static gboolean
 gst_dccp_client_src_start (GstBaseSrc * bsrc)
 {
@@ -323,10 +335,8 @@ gst_dccp_client_src_stop (GstBaseSrc * bsrc)
 
   src = GST_DCCP_CLIENT_SRC (bsrc);
 
-  if (src->sock_fd != -1 && src->closed) {
-    GST_DEBUG_OBJECT (src, "closing socket");
-    close (src->sock_fd);
-    src->sock_fd = -1;
+  if (src->sock_fd != DCCP_DEFAULT_SOCK_FD && src->closed) {
+    gst_dccp_socket_close (GST_ELEMENT (src), &(src->sock_fd));
   }
 
   return TRUE;
@@ -353,7 +363,7 @@ gst_dccp_client_src_class_init (GstDCCPClientSrcClass * klass)
 
   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PORT,
       g_param_spec_int ("port", "Port",
-          "The port to receive the packets from, 0=allocate", 0, G_MAXUINT16,
+          "The port to receive packets from", 0, G_MAXUINT16,
           DCCP_DEFAULT_PORT, G_PARAM_READWRITE));
 
   g_object_class_install_property (gobject_class, PROP_HOST,
@@ -383,8 +393,8 @@ gst_dccp_client_src_class_init (GstDCCPClientSrcClass * klass)
   /* signals */
   /**
    * GstDccpClientSrc::connected:
-   * @src: the gstdccpclientsrc instance
-   * @fd: the connected socket fd
+   * @src: the gstdccpclientsrc element that emitted this signal
+   * @fd: the connected socket file descriptor
    *
    * Reports that the element has connected, giving the fd of the socket
    */
index 3121acdfdbdfaea51522d1440256016696cea175..e010dfcaa2731245272bb708d8df64ab2a22b001 100644 (file)
@@ -98,6 +98,13 @@ GST_BOILERPLATE (GstDCCPServerSink, gst_dccp_server_sink, GstBaseSink,
 
 static guint gst_dccp_server_sink_signals[LAST_SIGNAL] = { 0 };
 
+/*
+ * Create a new client with the socket and the MTU
+ *
+ * @param element - the gstdccpserversink instance
+ * @param socket - the client socket
+ * @return the client
+ */
 static Client *
 gst_dccp_server_create_client (GstElement * element, int socket)
 {
@@ -106,6 +113,9 @@ gst_dccp_server_create_client (GstElement * element, int socket)
   client->pksize = gst_dccp_get_max_packet_size (element, client->socket);
   client->flow_status = GST_FLOW_OK;
 
+  GST_DEBUG_OBJECT (element, "Creating a new client with fd %d and MTU %d.",
+      client->socket, client->pksize);
+
   /* the socket is connected */
   g_signal_emit (element, gst_dccp_server_sink_signals[SIGNAL_CONNECTED], 0,
       socket);
@@ -113,6 +123,11 @@ gst_dccp_server_create_client (GstElement * element, int socket)
   return client;
 }
 
+/*
+ * Wait connections of new clients
+ *
+ * @param arg - the gstdccpserversink instance
+ */
 static void *
 gst_dccp_server_accept_new_clients (void *arg)
 {
@@ -132,6 +147,11 @@ gst_dccp_server_accept_new_clients (void *arg)
   }
 }
 
+/*
+ * Send the buffer to a client
+ *
+ * @param arg - the client
+ */
 static void *
 gst_dccp_server_send_buffer (void *arg)
 {
@@ -148,7 +168,10 @@ gst_dccp_server_send_buffer (void *arg)
   return NULL;
 }
 
-/* Remove clients with problems to send */
+/* Remove clients with problems to send.
+ *
+ * @param arg - the gstdccpserversink instance
+ */
 static void *
 gst_dccp_server_delete_dead_clients (void *arg)
 {
@@ -185,23 +208,25 @@ gst_dccp_server_sink_init (GstDCCPServerSink * this,
   this->clients = NULL;
 }
 
+/*
+ * Starts the element. If the sockfd property was not the default, this method
+ * will wait for a client connection.  If wait-connections property is true, it
+ * creates a thread to wait for new client connections.
+ *
+ * @param bsink - the element
+ * @return TRUE if the send operation was successful, FALSE otherwise.
+ */
 static gboolean
 gst_dccp_server_sink_start (GstBaseSink * bsink)
 {
   GstDCCPServerSink *sink = GST_DCCP_SERVER_SINK (bsink);
-  int ret = 1;
   Client *client;
 
-  /* create socket */
   if ((sink->sock_fd = gst_dccp_create_new_socket (GST_ELEMENT (sink))) < 0) {
     return FALSE;
   }
 
-  /* make address reusable */
-  if (setsockopt (sink->sock_fd, SOL_SOCKET, SO_REUSEADDR,
-          (void *) &ret, sizeof (ret)) < 0) {
-    GST_ELEMENT_ERROR (sink, RESOURCE, SETTINGS, (NULL),
-        ("Could not setsockopt: %s", g_strerror (errno)));
+  if (!gst_dccp_make_address_reusable (GST_ELEMENT (sink), sink->sock_fd)) {
     return FALSE;
   }
 
@@ -290,16 +315,14 @@ gst_dccp_server_sink_stop (GstBaseSink * bsink)
     pthread_cancel (accept_thread_id);
   }
 
-  if (sink->sock_fd != -1 && sink->closed == TRUE) {
-    GST_DEBUG_OBJECT (sink, "closing socket");
-    close (sink->sock_fd);
-    sink->sock_fd = -1;
-  }
+  gst_dccp_socket_close (GST_ELEMENT (sink), &(sink->sock_fd));
 
   pthread_mutex_lock (&lock);
   for (i = 0; i < g_list_length (sink->clients); i++) {
     Client *client = (Client *) g_list_nth_data (sink->clients, i);
-    close (client->socket);
+    if (client->socket != DCCP_DEFAULT_CLIENT_SOCK_FD && sink->closed == TRUE) {
+      gst_dccp_socket_close (GST_ELEMENT (sink), &(client->socket));
+    }
     g_free (client);
   }
   pthread_mutex_unlock (&lock);
@@ -391,7 +414,7 @@ gst_dccp_server_sink_class_init (GstDCCPServerSinkClass * klass)
 
   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PORT,
       g_param_spec_int ("port", "Port",
-          "The port to receive the packets from, 0=allocate", 0, G_MAXUINT16,
+          "The port to listen to", 0, G_MAXUINT16,
           DCCP_DEFAULT_PORT, G_PARAM_READWRITE));
 
   g_object_class_install_property (gobject_class, PROP_CLIENT_SOCK_FD,
@@ -401,7 +424,7 @@ gst_dccp_server_sink_class_init (GstDCCPServerSinkClass * klass)
 
   g_object_class_install_property (gobject_class, PROP_CLOSED,
       g_param_spec_boolean ("close-socket", "Close",
-          "Close socket at end of stream",
+          "Close the client sockets at end of stream",
           DCCP_DEFAULT_CLOSED, G_PARAM_READWRITE));
 
   g_object_class_install_property (gobject_class, PROP_CCID,
@@ -418,8 +441,8 @@ gst_dccp_server_sink_class_init (GstDCCPServerSinkClass * klass)
   /* signals */
   /**
    * GstDccpServerSink::connected:
-   * @src: the gstdccpserversink instance
-   * @fd: the connected socket fd
+   * @sink: the gstdccpserversink element that emitted this signal
+   * @fd: the connected socket file descriptor
    *
    * Reports that the element has connected, giving the fd of the socket
    */
index d3d46b0da1ae51960a34c2013e5f967eef3e8433..93068bc6b45a62ce8d3a7d438a51f061d777a5c0 100644 (file)
@@ -56,7 +56,6 @@
 #include <fcntl.h>
 
 #define DCCP_DEFAULT_CAPS        NULL
-#define DCCP_DEFAULT_LISTEN_HOST NULL   /* listen on all interfaces */
 
 /* signals */
 enum
@@ -70,7 +69,6 @@ enum
 {
   PROP_0,
   PROP_PORT,
-  PROP_HOST,
   PROP_CLIENT_SOCK_FD,
   PROP_CLOSED,
   PROP_CCID,
@@ -97,6 +95,11 @@ GST_BOILERPLATE (GstDCCPServerSrc, gst_dccp_server_src, GstPushSrc,
 
 static guint gst_dccp_server_src_signals[LAST_SIGNAL] = { 0 };
 
+/*
+ * Read a buffer from the server socket
+ *
+ * @return GST_FLOW_OK if the send operation was successful, GST_FLOW_ERROR otherwise.
+ */
 static GstFlowReturn
 gst_dccp_server_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
 {
@@ -137,14 +140,6 @@ gst_dccp_server_src_set_property (GObject * object, guint prop_id,
   GstDCCPServerSrc *src = GST_DCCP_SERVER_SRC (object);
 
   switch (prop_id) {
-    case PROP_HOST:
-      if (!g_value_get_string (value)) {
-        g_warning ("host property cannot be NULL");
-        break;
-      }
-      g_free (src->host);
-      src->host = g_strdup (g_value_get_string (value));
-      break;
     case PROP_PORT:
       src->port = g_value_get_int (value);
       break;
@@ -193,9 +188,6 @@ gst_dccp_server_src_get_property (GObject * object, guint prop_id,
   GstDCCPServerSrc *src = GST_DCCP_SERVER_SRC (object);
 
   switch (prop_id) {
-    case PROP_HOST:
-      g_value_set_string (value, src->host);
-      break;
     case PROP_PORT:
       g_value_set_int (value, src->port);
       break;
@@ -217,7 +209,13 @@ gst_dccp_server_src_get_property (GObject * object, guint prop_id,
   }
 }
 
-
+/*
+ * Starts the element. If the sockfd property was not the default, this method
+ * will create a new server socket and wait for a client connection.
+ *
+ * @param bsrc - the element
+ * @return TRUE if the send operation was successful, FALSE otherwise.
+ */
 static gboolean
 gst_dccp_server_src_start (GstBaseSrc * bsrc)
 {
@@ -229,7 +227,9 @@ gst_dccp_server_src_start (GstBaseSrc * bsrc)
       return FALSE;
     }
 
-    gst_dccp_make_address_reusable (GST_ELEMENT (src), src->sock_fd);
+    if (!gst_dccp_make_address_reusable (GST_ELEMENT (src), src->sock_fd)) {
+      return FALSE;
+    }
 
     /* name the server socket */
     memset (&src->server_sin, 0, sizeof (src->server_sin));
@@ -283,7 +283,6 @@ gst_dccp_server_src_init (GstDCCPServerSrc * this,
     GstDCCPServerSrcClass * g_class)
 {
   this->port = DCCP_DEFAULT_PORT;
-  this->host = g_strdup (DCCP_DEFAULT_HOST);
   this->sock_fd = DCCP_DEFAULT_SOCK_FD;
   this->client_sock_fd = DCCP_DEFAULT_CLIENT_SOCK_FD;
   this->closed = DCCP_DEFAULT_CLOSED;
@@ -314,8 +313,6 @@ gst_dccp_server_src_finalize (GObject * gobject)
     this->caps = NULL;
   }
 
-  g_free (this->host);
-
   G_OBJECT_CLASS (parent_class)->finalize (gobject);
 }
 
@@ -327,10 +324,9 @@ gst_dccp_server_src_stop (GstBaseSrc * bsrc)
 
   src = GST_DCCP_SERVER_SRC (bsrc);
 
-  if (src->sock_fd != -1 && src->closed == TRUE) {
-    GST_DEBUG_OBJECT (src, "closing socket");
-    close (src->sock_fd);
-    src->sock_fd = -1;
+  gst_dccp_socket_close (GST_ELEMENT (src), &(src->sock_fd));
+  if (src->client_sock_fd != DCCP_DEFAULT_CLIENT_SOCK_FD && src->closed == TRUE) {
+    gst_dccp_socket_close (GST_ELEMENT (src), &(src->client_sock_fd));
   }
 
   return TRUE;
@@ -354,13 +350,9 @@ gst_dccp_server_src_class_init (GstDCCPServerSrcClass * klass)
 
   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PORT,
       g_param_spec_int ("port", "Port",
-          "The port to receive the packets from, 0=allocate", 0, G_MAXUINT16,
+          "The port to listen to", 0, G_MAXUINT16,
           DCCP_DEFAULT_PORT, G_PARAM_READWRITE));
 
-  g_object_class_install_property (gobject_class, PROP_HOST,
-      g_param_spec_string ("host", "Host", "The hostname to listen as",
-          DCCP_DEFAULT_LISTEN_HOST, G_PARAM_READWRITE));
-
   g_object_class_install_property (gobject_class, PROP_CLIENT_SOCK_FD,
       g_param_spec_int ("sockfd", "Socket fd",
           "The client socket file descriptor", -1, G_MAXINT,
@@ -368,7 +360,7 @@ gst_dccp_server_src_class_init (GstDCCPServerSrcClass * klass)
 
   g_object_class_install_property (gobject_class, PROP_CLOSED,
       g_param_spec_boolean ("close-socket", "Close socket",
-          "Close socket at the end of stream", DCCP_DEFAULT_CLOSED,
+          "Close client socket at the end of stream", DCCP_DEFAULT_CLOSED,
           G_PARAM_READWRITE));
 
   g_object_class_install_property (gobject_class, PROP_CCID,
@@ -383,8 +375,8 @@ gst_dccp_server_src_class_init (GstDCCPServerSrcClass * klass)
   /* signals */
   /**
    * GstDccpServerSrc::connected:
-   * @src: the gstdccpserversrc instance
-   * @fd: the connected socket fd
+   * @src: the gstdccpserversrc element that emitted this signal
+   * @fd: the connected socket file descriptor
    *
    * Reports that the element has connected, giving the fd of the socket
    */
index 87ef19a54a1f4597bb959b86d7b356c15aef32c8..e0dd3f162ca77c9c5005e57078ce2b295747b001 100644 (file)
@@ -53,7 +53,6 @@ struct _GstDCCPServerSrc
 
   /* server information */
   int port;
-  gchar *host;
   struct sockaddr_in server_sin;
 
   /* socket */