View Source Membrane.TCP.Sink (Membrane TCP plugin v0.1.0)
Element that sends buffers received on the input pad over a TCP socket.
Element options
Passed via struct Membrane.TCP.Sink.t/0
connection_side
:client | :server
Default value:
:server
Determines whether this element will behave like a server or a client when establishing TCP connection.server_address
:inet.ip_address() | nil
Default value:
nil
An IP Address of the server the packets will be sent to. (nil in case ofconnection_side: :server
)server_port_no
:inet.port_number() | nil
Default value:
nil
A TCP port number of the server the packets will be sent to. (nil in case ofconnection_side: :server
)local_address
:inet.socket_address()
Default value:
:any
An IP Address from which the socket will connect or will listen on. It allows to choose which network interface to use if there's more than one.local_port_no
:inet.port_number()
Default value:
0
A TCP port number used when connecting to a listening socket or starting a listening socket. If not specified any free port is chosen.local_socket
Socket.t()
Default value:
nil
Already connected TCP socket with connection side mathing the one passed as an option, has to be connected.
Pads
:input
Accepted formats:
_any
Direction: | :input |
Availability: | :always |
Flow control: | :auto |
Summary
Types
Struct containing options for Membrane.TCP.Sink
Types
@type t() :: %Membrane.TCP.Sink{ connection_side: :client | :server, local_address: :inet.socket_address(), local_port_no: :inet.port_number(), local_socket: Membrane.TCP.Socket.t(), server_address: :inet.ip_address() | nil, server_port_no: :inet.port_number() | nil }
Struct containing options for Membrane.TCP.Sink
Functions
@spec options() :: keyword()
Returns description of options available for this module