AgsOscConnection

AgsOscConnection — the OSC server side connection

Functions

pthread_mutex_t * ags_osc_connection_get_class_mutex ()
gboolean ags_osc_connection_test_flags ()
void ags_osc_connection_set_flags ()
void ags_osc_connection_unset_flags ()
gboolean ags_osc_connection_timeout_expired ()
unsigned char * ags_osc_connection_read_bytes ()
gint64 ags_osc_connection_write_response ()
void ags_osc_connection_close ()
AgsOscConnection * ags_osc_connection_new ()
#define AGS_IS_OSC_CONNECTION()
#define AGS_OSC_CONNECTION()
#define AGS_OSC_CONNECTION_CLASS()
#define AGS_OSC_CONNECTION_GET_CLASS()
GType ags_osc_connection_get_type ()

Properties

gchar * ip4 Read / Write
gchar * ip6 Read / Write
AgsOscServer * osc-server Read / Write

Signals

void close Run Last
gpointer read-bytes Run Last
gint64 write-response Run Last

Types and Values

#define AGS_OSC_CONNECTION_TIMEOUT_USEC
#define AGS_OSC_CONNECTION_DEAD_LINE_USEC
#define AGS_OSC_CONNECTION_CHUNK_SIZE
#define AGS_OSC_CONNECTION_DEFAULT_CACHE_DATA_LENGTH
enum AgsOscConnectionFlags
#define AGS_TYPE_OSC_CONNECTION
struct AgsOscConnection
struct AgsOscConnectionClass

Object Hierarchy

    GObject
    ╰── AgsOscConnection

Includes

#include <ags/audio/osc/ags_osc_connection.h>

Description

AgsOscConnection your OSC server side connection.

Functions

ags_osc_connection_get_class_mutex ()

pthread_mutex_t *
ags_osc_connection_get_class_mutex ();

Use this function's returned mutex to access mutex fields.

Returns

the class mutex

Since: 2.1.0

ags_osc_connection_test_flags ()

gboolean
ags_osc_connection_test_flags (AgsOscConnection *osc_connection,
                               guint flags);

Test flags to be set on osc_connection .

Parameters

osc_connection

the AgsOscConnection

  

flags

the flags

  

Returns

TRUE if flags are set, else FALSE

Since: 2.1.0

ags_osc_connection_set_flags ()

void
ags_osc_connection_set_flags (AgsOscConnection *osc_connection,
                              guint flags);

Set flags.

Parameters

osc_connection

the AgsOscConnection

  

flags

the flags

  

Since: 2.1.0

ags_osc_connection_unset_flags ()

void
ags_osc_connection_unset_flags (AgsOscConnection *osc_connection,
                                guint flags);

Unset flags.

Parameters

osc_connection

the AgsOscConnection

  

flags

the flags

  

Since: 2.1.0

ags_osc_connection_timeout_expired ()

gboolean
ags_osc_connection_timeout_expired (struct timespec *start_time,
                                    struct timespec *timeout_delay);

Check start_time plus timeout_delay against current time.

Parameters

start_time

the start time timespec

  

timeout_delay

the delay timespec

  

Returns

TRUE if timeout expired, otherwise FALSE

Since: 2.1.10

ags_osc_connection_read_bytes ()

unsigned char *
ags_osc_connection_read_bytes (AgsOscConnection *osc_connection,
                               guint *data_length);

Read bytes.

Parameters

osc_connection

the AgsOscConnection

  

data_length

the return location of byte array's length

  

Returns

byte array read or NULL if no data available

Since: 2.1.0

ags_osc_connection_write_response ()

gint64
ags_osc_connection_write_response (AgsOscConnection *osc_connection,
                                   GObject *osc_response);

Write response.

Parameters

osc_connection

the AgsOscConnection

  

osc_response

the AgsOscResponse

  

Returns

the count of bytes written

Since: 2.1.0

ags_osc_connection_close ()

void
ags_osc_connection_close (AgsOscConnection *osc_connection);

Close osc_connection .

Parameters

osc_connection

the AgsOscConnection

  

Since: 2.1.0

ags_osc_connection_new ()

AgsOscConnection *
ags_osc_connection_new (GObject *osc_server);

Creates a new instance of AgsOscConnection

Parameters

osc_server

the AgsOscServer

  

Returns

the new AgsOscConnection

Since: 2.1.0

AGS_IS_OSC_CONNECTION()

#define AGS_IS_OSC_CONNECTION(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_OSC_CONNECTION))

AGS_OSC_CONNECTION()

#define AGS_OSC_CONNECTION(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_OSC_CONNECTION, AgsOscConnection))

AGS_OSC_CONNECTION_CLASS()

#define AGS_OSC_CONNECTION_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_OSC_CONNECTION, AgsOscConnectionClass))

AGS_OSC_CONNECTION_GET_CLASS()

#define AGS_OSC_CONNECTION_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_OSC_CONNECTION, AgsOscConnectionClass))

ags_osc_connection_get_type ()

GType
ags_osc_connection_get_type (void);

Types and Values

AGS_OSC_CONNECTION_TIMEOUT_USEC

#define AGS_OSC_CONNECTION_TIMEOUT_USEC (250)

AGS_OSC_CONNECTION_DEAD_LINE_USEC

#define AGS_OSC_CONNECTION_DEAD_LINE_USEC (60000000)

AGS_OSC_CONNECTION_CHUNK_SIZE

#define AGS_OSC_CONNECTION_CHUNK_SIZE (131072)

AGS_OSC_CONNECTION_DEFAULT_CACHE_DATA_LENGTH

#define AGS_OSC_CONNECTION_DEFAULT_CACHE_DATA_LENGTH (256)

enum AgsOscConnectionFlags

Members

AGS_OSC_CONNECTION_ACTIVE

    

AGS_OSC_CONNECTION_INET4

    

AGS_OSC_CONNECTION_INET6

    

AGS_TYPE_OSC_CONNECTION

#define AGS_TYPE_OSC_CONNECTION                (ags_osc_connection_get_type ())

struct AgsOscConnection

struct AgsOscConnection;

struct AgsOscConnectionClass

struct AgsOscConnectionClass {
  GObjectClass gobject;

  unsigned char* (*read_bytes)(AgsOscConnection *osc_connection,
			       guint *data_length);
  gint64 (*write_response)(AgsOscConnection *osc_connection,
			   GObject *osc_response);
  
  void (*close)(AgsOscConnection *osc_connection);
};

Property Details

The “ip4” property

  “ip4”                      gchar *

The IPv4 address as string of the server connection.

Flags: Read / Write

Default value: NULL

Since: 2.1.0

The “ip6” property

  “ip6”                      gchar *

The IPv6 address as string of the server connection.

Flags: Read / Write

Default value: NULL

Since: 2.1.0

The “osc-server” property

  “osc-server”               AgsOscServer *

The assigned AgsOscServer.

Flags: Read / Write

Since: 2.1.0

Signal Details

The “close” signal

void
user_function (AgsOscConnection *osc_connection,
               gpointer          user_data)

The ::close signal is emited as closing the file descriptor.

Parameters

osc_connection

the AgsOscConnection

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

Since: 2.1.0

The “read-bytes” signal

gpointer
user_function (AgsOscConnection *osc_connection,
               gpointer          data_length,
               gpointer          user_data)

The ::read-bytes signal is emited while read bytes.

Parameters

osc_connection

the AgsOscConnection

  

data_length

the return location of byte array's length

  

user_data

user data set when the signal handler was connected.

  

Returns

byte array read or NULL if no data available

Flags: Run Last

Since: 2.1.0

The “write-response” signal

gint64
user_function (AgsOscConnection *osc_connection,
               GObject          *osc_response,
               gpointer          user_data)

The ::write-response signal is emited while write response.

Parameters

osc_connection

the AgsOscConnection

  

osc_response

the AgsOscResponse

  

user_data

user data set when the signal handler was connected.

  

Returns

the count bytes written

Flags: Run Last

Since: 2.1.0

Generated by GTK-Doc V1.28