liberipc/include/eripccontentlister.h File Reference

liberipc - specifics to IPC with contentlister More...

#include "eripcclient.h"

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	eCcCl {   ccClStore = 0, ccClMSDiskSetConnected, ccClGotoPage, ccClBatteryLow,   ccClToolbarIcon, ccClStoragePresent, ccClToolbarSynchronised, ccClBusyIndicator,   ccClDisplayUpdated, ccClNewContent, ccClPenClick, ccClEnableAudio,   ccClUndefined }
enum	eCcClBatteryAction { ccClBattery_warning = 0, ccClBattery_shutdown }
Functions
int	clParseCommand (char *szCommand, erIpcCmd_t *pCmd)
int	clStore (erClientChannel_t channel, int uaID, int category, char *itemID, char *itemLocation)
int	MSDiskSetConnected (erClientChannel_t channel, int connected)
int	clGotoPage (erClientChannel_t channel, int page)
int	clBatteryLow (erClientChannel_t channel, eCcClBatteryAction action, int percentage, int time_left)
int	clStoragePresent (erClientChannel_t channel, char *storageType, int storagePresent)
int	clBusyIndicator (erClientChannel_t channel, eCcBusyState status)
int	clDisplayUpdated (erClientChannel_t channel)
int	clNewContent (erClientChannel_t channel)
int	clPenClick (erClientChannel_t channel)
int	clEnableAudio (erClientChannel_t channel, int volume)

---

Detailed Description

liberipc - specifics to IPC with contentlister

<File description>="">

Definition in file eripccontentlister.h.

---

Enumeration Type Documentation

enum eCcCl

Enumerator:

ccClStore
ccClMSDiskSetConnected
ccClGotoPage
ccClBatteryLow
ccClToolbarIcon
ccClStoragePresent
ccClToolbarSynchronised
ccClBusyIndicator
ccClDisplayUpdated
ccClNewContent
ccClPenClick
ccClEnableAudio
ccClUndefined

Definition at line 41 of file eripccontentlister.h.

             {
    ccClStore = 0,
    ccClMSDiskSetConnected,
    ccClGotoPage,
    ccClBatteryLow,
    ccClToolbarIcon,
    ccClStoragePresent,
    ccClToolbarSynchronised,
    ccClBusyIndicator,
    ccClDisplayUpdated,
    ccClNewContent,
    ccClPenClick,
    ccClEnableAudio,
    ccClUndefined
} eCcCl;

enum eCcClBatteryAction

Enumerator:

ccClBattery_warning
ccClBattery_shutdown

Definition at line 57 of file eripccontentlister.h.

             {
    ccClBattery_warning = 0,
    ccClBattery_shutdown
} eCcClBatteryAction;

---

Function Documentation

int clBatteryLow	(	erClientChannel_t	channel,
		eCcClBatteryAction	action,
		int	percentage,
		int	time_left
	)

Notify the contentmanager that the battery level is low

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	action	requested from contetnLister
	battery	charge as 0 .. 100%
	estimated	time left (in minutes)

Returns:

A value of 0 signals success

Definition at line 243 of file eripccontentlister.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ccClBatteryLow");
    cmd.cc = (int) ccClBatteryLow;
    cmd.nArg = 3;
    sprintf(cmd.arg[0], "%d", action);
    sprintf(cmd.arg[1], "%d", percentage);
    sprintf(cmd.arg[2], "%d", time_left);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int clBusyIndicator	(	erClientChannel_t	channel,
		eCcBusyState	status
	)

Notify the contentmanager that busyIndicator changes its status

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	status	busybar change to the 'status'

Returns:

A value of 0 signals success

Definition at line 271 of file eripccontentlister.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ccClBusyIndicator");
    cmd.cc = (int) ccClBusyIndicator;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", status);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int clDisplayUpdated

(

erClientChannel_t

channel

)

Notify the contentmanager that display Updated

Parameters:

channel

Opaque datastructure that contains info on communication channel

Returns:

A value of 0 signals success

Definition at line 283 of file eripccontentlister.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ccClDisplayUpdated");
    cmd.cc = (int) ccClDisplayUpdated;
    cmd.nArg = 0;

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int clEnableAudio	(	erClientChannel_t	channel,
		int	volume
	)

Called by settings application when user changes the sound settings

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	volume	0=disabled, >0=enabled

Returns:

A value of 0 signals success

Definition at line 316 of file eripccontentlister.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ccClEnableAudio");
    cmd.cc = (int) ccClEnableAudio;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", volume);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int clGotoPage	(	erClientChannel_t	channel,
		int	page
	)

Notify the contentmanager it should goto a new page

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	page	pagenumber to jump to

Returns:

A value of 0 signals success

Definition at line 231 of file eripccontentlister.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ccClGotoPage");
    cmd.cc = (int) ccClGotoPage;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", page);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int clNewContent

(

erClientChannel_t

channel

)

Notify the contentmanager that new content has been downloaded

Parameters:

channel

Opaque datastructure that contains info on communication channel

Returns:

A value of 0 signals success

Definition at line 294 of file eripccontentlister.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ccClNewContent");
    cmd.cc = (int) ccClNewContent;
    cmd.nArg = 0;

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int clParseCommand	(	char *	szCommand,
		erIpcCmd_t *	pCmd
	)

Copyright (C) 2005-2008 iRex Technologies B.V. All rights reserved.

Definition at line 43 of file eripccontentlister.c.

{
    int     i;
    char   *pChar;
    int     cmdcode;
    char    szToken[TB_MAXCHARONLINE];
    int     nReqArgs = 0;

    pCmd->cc = (int) ccClUndefined;
    for (i = 0; i < TB_N_ARG; i++)
    {
        strcpy(pCmd->arg[i], "");
    }

    // Parse Command
    pChar = szCommand;
    i = 0;
    while (*pChar != '\0')
    {
        szToken[i] = '\0';
        if (*pChar == ',')
        {
            pChar++;
            break;
        }
        szToken[i] = *pChar++;
        i++;
        szToken[i] = '\0';
    }

    // We have found the command Token. Figure out what the command is.
    // TODO: stop doing this hardcoded, rely on a smart datastructure instead.
    if (isdigit(szToken[0]))
    {
        cmdcode = atoi(szToken);
    }
    else
    {
        cmdcode = -1;
    }
    if (strcmp(szToken, "ccClStore") == 0  ||  cmdcode == ccClStore)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClStore;
        nReqArgs = 4;
        pCmd->nArg = 4;
    }
    else if (strcmp(szToken, "ccClMSDiskSetConnected") == 0  ||  cmdcode == ccClMSDiskSetConnected)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClMSDiskSetConnected;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "ccClGotoPage") == 0  ||  cmdcode == ccClGotoPage)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClGotoPage;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "ccClBatteryLow") == 0  ||  cmdcode == ccClBatteryLow)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClBatteryLow;
        nReqArgs = 3;
        pCmd->nArg = 3;
    }
    else if (strcmp(szToken, "ccClToolbarIcon") == 0  ||  cmdcode == ccClToolbarIcon)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClToolbarIcon;
        nReqArgs = 2;
        pCmd->nArg = 2;
    }
    else if (strcmp(szToken, "ccClStoragePresent") == 0  ||  cmdcode == ccClStoragePresent)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClStoragePresent;
        nReqArgs = 2;
        pCmd->nArg = 2;
    }
    else if (strcmp(szToken, "ccClToolbarSynchronised") == 0  ||  cmdcode == ccClToolbarSynchronised)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClToolbarSynchronised;
        nReqArgs = 0;
        pCmd->nArg = 0;
    }
    else if (strcmp(szToken, "ccClBusyIndicator") == 0  ||  cmdcode == ccClBusyIndicator)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClBusyIndicator;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }   
    else if (strcmp(szToken, "ccClDisplayUpdated") == 0  ||  cmdcode == ccClDisplayUpdated)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClDisplayUpdated;
        nReqArgs = 0;
        pCmd->nArg = 0;
    }   
    else if (strcmp(szToken, "ccClNewContent") == 0  ||  cmdcode == ccClNewContent)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClNewContent;
        nReqArgs = 0;
        pCmd->nArg = 0;
    }
    else if (strcmp(szToken, "ccClPenClick") == 0  ||  cmdcode == ccClPenClick)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClPenClick;
        nReqArgs = 0;
        pCmd->nArg = 0;
    }
    else if (strcmp(szToken, "ccClEnableAudio") == 0  ||  cmdcode == ccClEnableAudio)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccClEnableAudio;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else
    {
        strcpy(pCmd->name, "ccClUndefined");
        pCmd->cc = (int) ccClUndefined;
        fprintf(stderr, "%s: Command %s \n", __FUNCTION__, szToken);
        fprintf(stderr, "Error parsing (%s). Command undefined\n", szCommand);
        pCmd->nArg = -1;
        return -1;
    }

    if (nReqArgs > 0)
    {
        erIpcGetArgs(pChar, pCmd, nReqArgs);
    }
    return 0;
}

Here is the call graph for this function:

int clPenClick

(

erClientChannel_t

channel

)

Notify the Content Lister that a pen click event is occurred

Parameters:

channel

Opaque datastructure that contains info on communication channel

Returns:

A value of 0 signals success

Definition at line 305 of file eripccontentlister.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ccClPenClick");
    cmd.cc = (int) ccClPenClick;
    cmd.nArg = 0;

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int clStoragePresent	(	erClientChannel_t	channel,
		char *	storageType,
		int	storagePresent
	)

Notify the contentmanager that a storage module has been inserted or removed

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	storage	module identification
	1/0	= module present yes/no

Returns:

A value of 0 signals success

Definition at line 257 of file eripccontentlister.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ccClStoragePresent");
    cmd.cc = (int) ccClStoragePresent;
    cmd.nArg = 2;
    sprintf(cmd.arg[0], "%s", storageType);
    sprintf(cmd.arg[1], "%d", storagePresent);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int clStore	(	erClientChannel_t	channel,
		int	uaID,
		int	category,
		char *	itemID,
		char *	itemLocation
	)

Store the currently displayed page for this category

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier
	category	identifier
	itemID	- null terminated string - unique item ID of the currently displayed content
	itemLocation	- null terminated string

Returns:

A value of 0 signals success

Definition at line 184 of file eripccontentlister.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ccClStore");
    cmd.cc = (int) ccClStore;
    cmd.nArg = 4;
    sprintf(cmd.arg[0], "%d", uaID);
    sprintf(cmd.arg[1], "%d", category);
    
    if ((itemID) && (strlen(itemID) < TB_ARGLENGTH))
    {
        strncpy(cmd.arg[2], itemID, TB_ARGLENGTH);
    }
    else
    {
        sprintf(cmd.arg[2],"%s", "");
         fprintf(stderr, "Command %s \n", cmd.name);
         fprintf(stderr, "invalid itemID (%s)\n", itemID);
     }

    if ((itemLocation) && (strlen(itemLocation) < TB_ARGLENGTH))
    {
        strncpy(cmd.arg[3], itemLocation, TB_ARGLENGTH);
    }
    else
    {
        sprintf(cmd.arg[3],"%s", "");
         fprintf(stderr, "Command %s \n", cmd.name);
         fprintf(stderr, "invalid itemLocation (%s)\n", itemLocation);
     }

    return erIpcSndCommand(channel, &cmd);    
}

Here is the call graph for this function:

int MSDiskSetConnected	(	erClientChannel_t	channel,
		int	connected
	)

Notify the contentmanager that we are connected to the PC

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	connected	boolean showing connection status

Returns:

A value of 0 signals success

Definition at line 219 of file eripccontentlister.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "ccClMSDiskSetConnected");
    cmd.cc = (int) ccClMSDiskSetConnected;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", connected);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function: