controlsocket

controlsocket

Synopsis




#define             XMMS_PROTOCOL_VERSION
#define             CTRLSOCKET_NAME
#define             CTRLSOCKET_IO_TIMEOUT_USEC
                    ClientPktHeader;
                    ServerPktHeader;
                    PacketNode;
gboolean            ctrlsocket_setup                    (void);
gboolean            ctrlsocket_setup_unix               (void);
gboolean            ctrlsocket_setup_tcp                (void);
void                ctrlsocket_start                    (void);
void                ctrlsocket_check                    (void);
void                ctrlsocket_cleanup                  (void);
gint                ctrlsocket_get_session_id           (void);

Description

Details

XMMS_PROTOCOL_VERSION

#define XMMS_PROTOCOL_VERSION	     1


CTRLSOCKET_NAME

#define CTRLSOCKET_NAME              "audacious"


CTRLSOCKET_IO_TIMEOUT_USEC

#define CTRLSOCKET_IO_TIMEOUT_USEC   100000


ClientPktHeader

typedef struct {
    guint16 version;
    guint16 command;
    guint32 data_length;
} ClientPktHeader;


ServerPktHeader

typedef struct {
    guint16 version;
    guint32 data_length;
} ServerPktHeader;


PacketNode

typedef struct {
    ClientPktHeader hdr;
    gpointer data;
    gint fd;
} PacketNode;


ctrlsocket_setup ()

gboolean            ctrlsocket_setup                    (void);

Returns :

ctrlsocket_setup_unix ()

gboolean            ctrlsocket_setup_unix               (void);

Returns :

ctrlsocket_setup_tcp ()

gboolean            ctrlsocket_setup_tcp                (void);

Returns :

ctrlsocket_start ()

void                ctrlsocket_start                    (void);


ctrlsocket_check ()

void                ctrlsocket_check                    (void);


ctrlsocket_cleanup ()

void                ctrlsocket_cleanup                  (void);


ctrlsocket_get_session_id ()

gint                ctrlsocket_get_session_id           (void);

Returns :