socketsrc

socketsrc

Synopsis

struct              GstSocketSrc;

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GstObject
               +----GstElement
                     +----GstBaseSrc
                           +----GstPushSrc
                                 +----GstSocketSrc

Properties

  "socket"                   GSocket*              : Read / Write
  "caps"                     GstCaps*              : Read / Write
  "send-messages"            gboolean              : Read / Write

Signals

  "connection-closed-by-peer"                      : Run First

Description

Receive data from a socket.

As compared to other elements:

socketsrc can be considered a source counterpart to the multisocketsink sink.

socketsrc can also be considered a generalization of tcpclientsrc and tcpserversrc: it contains all the logic required to communicate over the socket but none of the logic for creating the sockets/establishing the connection in the first place, allowing the user to accomplish this externally in whatever manner they wish making it applicable to other types of sockets besides TCP.

As compared to fdsrc socketsrc is socket specific and deals with GSocket objects rather than sockets via integer file-descriptors.

see_also: multisocketsink

Synopsis

Element Information

plugin

tcp

author

Thomas Vander Stichele <thomas at apestaart dot org>, William Manley <will@williammanley.net>

class

Source/Network

Element Pads

name

src

direction

source

presence

always

details

ANY

Details

struct GstSocketSrc

struct GstSocketSrc;

Property Details

The "socket" property

  "socket"                   GSocket*              : Read / Write

The socket to receive packets from.


The "caps" property

  "caps"                     GstCaps*              : Read / Write

The caps of the source pad.


The "send-messages" property

  "send-messages"            gboolean              : Read / Write

Control if the source will handle GstNetworkMessage events. The event is a CUSTOM event named 'GstNetworkMessage' and contains:

"buffer", GST_TYPE_BUFFER : the buffer with data to send

The buffer in the event will be sent on the socket. This allows for simple bidirectional communication.

Default value: FALSE

Since 1.8.0

Signal Details

The "connection-closed-by-peer" signal

void                user_function                      (GstSocketSrc *gstsocketsrc,
                                                        gpointer      user_data)         : Run First