include/hiker/exgmgr2.h

Go to the documentation of this file.

/********************************************************************
 *
 * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
 * Copyright 2006, 2007, ACCESS Systems Americas, Inc. All rights reserved.
 *
 * Version: MPL 1.1/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is hikerproject.org code.
 *
 * The Initial Developer of the Original Code is ACCESS Systems Americas, Inc.
 *               Portions created by the Initial Developer are
 *      Copyright 2006-2007 the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
 * case the provisions of the LGPL are applicable instead of those above.
 * If you wish to allow use of your version of this file only under the terms
 * of the LGPL, and not to allow others to use your version of this file under
 * the terms of the MPL, indicate your decision by deleting the provisions
 * above and replace them with the notice and other provisions required by
 * the LGPL. If you do not delete the provisions above, a recipient may use
 * your version of this file under the terms of either the MPL or the LGPL. 
 * You may obtain a copy of the LGPL at http://www.gnu.org/licenses/lgpl.txt.
 *
 ********************************************************************/

#ifndef ALP_EXGMGR2_H_
#define ALP_EXGMGR2_H_

#include <sys/types.h>
#include <hiker/types.h>
#include <hiker/sysclass.h>

#ifdef __cplusplus
 extern "C"
 {
#endif


#define ALP_EXG2_OUTOFMEMORY_ERR                                ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00010000))

#define ALP_EXG2_NOTRANSPORTS_ERR                               ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00020000))

#define ALP_EXG2_DAEMONFAILURE_ERR                              ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00030000))

#define ALP_EXG2_LIBRARYFAILURE_ERR                             ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00040000))

#define ALP_EXG2_PARAMNOTFOUND_ERR                              ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00050000))

#define ALP_EXG2_INVALIDAPIPARAM_ERR                            ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00060000))

#define ALP_EXG2_CREATESOCKET_ERR                               ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00070000))

#define ALP_EXG2_BINDSOCKET_ERR                                 ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00080000))

#define ALP_EXG2_LISTENSOCKET_ERR                               ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00090000))

#define ALP_EXG2_CONNECTSOCKET_ERR                              ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x000A0000))

#define ALP_EXG2_WRITESOCKET_ERR                                        ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x000B0000))

#define ALP_EXG2_READSOCKET_ERR                                 ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x000C0000))

#define ALP_EXG2_FCNTLSOCKET_ERR                                        ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x000D0000))

#define ALP_EXG2_VERBTOOLONG_ERR                                        ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x000E0000))

#define ALP_EXG2_LOCALIZEDVERBTOOLONG_ERR               ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x000F0000))

#define ALP_EXG2_SUBJECTTOOLONG_ERR                             ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00100000))

#define ALP_EXG2_MIMETYPETOOLONG_ERR                            ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00110000))

#define ALP_EXG2_BUNDLENAMETOOLONG_ERR                  ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00120000))

#define ALP_EXG2_HANDLERALREADYREGISTERED_ERR   ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00140000))

#define ALP_EXG2_HANDLERREGISTEREDINACTIVE_ERR  ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00150000))

#define ALP_EXG2_HANDLERNOTFOUND_ERR                            ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00160000))

#define ALP_EXG2_HANDLERISLOCALONLY_ERR                         ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00170000))

#define ALP_EXG2_HANDLERTIMEOUT_ERR                             ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00180000))

#define ALP_EXG2_REGCACHE_ERR                                   ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00190000))

#define ALP_EXG2_CREATEFILE_ERR                                 ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00200000))

#define ALP_EXG2_ACCESSFILE_ERR                                 ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00210000))

#define ALP_EXG2_WRITEFILE_ERR                                  ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00220000))

#define ALP_EXG2_READFILE_ERR                                   ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00230000))

#define ALP_EXG2_GSOURCE_ERR                                    ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00240000))

#define ALP_EXG2_BROKENPIPE_ERR                         ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00250000))

#define ALP_EXG2_REQUESTNOTFOUND_ERR                            ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00300000))

#define ALP_EXG2_REQUESTALREADYRECEIVED_ERR                     ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00310000))

#define ALP_EXG2_CANNOTSENDFD_ERR                       ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00320000))

#define ALP_EXG2_CANNOTRCVFD_ERR                        ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00330000))

#define ALP_EXG2_OBJECTNOTREADY_ERR                     ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00340000))

#define ALP_EXG2_NOMOREOBJECTS_ERR                      ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00350000))

#define ALP_EXG2_USERCANCEL_ERR                 ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00360000))

#define ALP_EXG2_UNKNOWN_ERR                    ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00370000))

#define ALP_EXG2_TIMEOUT_ERR                    ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00380000))

#define ALP_EXG2_PROGRAM_ERR                    ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00500000))

#define ALP_EXG2_FIRST_EXT_ERR                  ((alp_status_t) (ALP_CLASS_EXCHANGE2 | 0x00800000))


// -------------------------------------------------------------------------------------------------------------------------

#define ALP_EXG2_SEND_ACTIONCLASS       "exg_send_predef"

#define ALP_EXG2_GET_ACTIONCLASS        "exg_get_predef"

#define ALP_EXG2_PRINT_ACTIONCLASS      "exg_print_predef"

#define ALP_EXG2_EDIT_ACTIONCLASS       "exg_edit_predef"

#define ALP_EXG2_VIEW_ACTIONCLASS       "exg_view_predef"

#define ALP_EXG2_DIAL_ACTIONCLASS       "exg_dial_predef"

#define ALP_EXG2_IMPORT_ACTIONCLASS     "exg_import_predef"

#define ALP_EXG2_EXPORT_ACTIONCLASS     "exg_export_predef"


// -------------------------------------------------------------------------------------------------------------------------

#define ALP_EXG2_BUNDLE_LOCALE_VERB_PREFIX "RSC=^t/"

#define ALP_EXG2_BUNDLE_LOCALE_VERB_BUNDLE_PREFIX(bundle) "RSC=" bundle "/^t/"


// -------------------------------------------------------------------------------------------------------------------------

#define ALP_EXG2_NOWILDCARD_PREFIX "nowcp_"

#define ALP_EXG2_PHONESTRING_SUBJECT ALP_EXG2_NOWILDCARD_PREFIX"phonestr_predef"

#define ALP_EXG2_EXTENDEDPHONESTRING_SUBJECT ALP_EXG2_NOWILDCARD_PREFIX"extphonestr_predef"

#define ALP_EXG2_CONTACT_IDENTIFIER_STRING_SUBJECT ALP_EXG2_NOWILDCARD_PREFIX"contactidstr_predef"

#define ALP_EXG2_URLSTRING_SUBJECT ALP_EXG2_NOWILDCARD_PREFIX"urlstr_predef"

#define ALP_EXG2_RTSPURLSTRING_SUBJECT ALP_EXG2_NOWILDCARD_PREFIX"rtspstr_predef"

#define ALP_EXG2_EMAILSTRING_SUBJECT ALP_EXG2_NOWILDCARD_PREFIX"emailstr_predef"


// -------------------------------------------------------------------------------------------------------------------------

typedef void *AlpExg2Request;
typedef void *AlpExg2RequestId;

// -------------------------------------------------------------------------------------------------------------------------

#define ALP_EXG2_VERB_MAXLEN                    30

#define ALP_EXG2_LOCALIZED_VERB_MAXLEN  60

#define ALP_EXG2_SUBJECT_MAXLEN         50

#define ALP_EXG2_BUNDLENAME_MAXLEN      150


// -------------------------------------------------------------------------------------------------------------------------

typedef int alp_exg_async_execute_event_t;
#define ALP_EXG2_ASYNC_EXECUTE_EVENT_COMPLETE 1

typedef struct _AlpExgAsyncExecuteEventInfoType
{
        alp_exg_async_execute_event_t event;
        union
        {
                struct _evtcomplete
                {
                        alp_status_t completeStatus;
                } evtcomplete;          
        } params;
} AlpExgAsyncExecuteEventInfoType;

// -------------------------------------------------------------------------------------------------------------------------

#define ALP_EXG2_HINT_MEDIA_TYPE_INT_PARAM "exg_mediatype"
#define ALP_EXG2_HINT_MEDIA_TYPE_LOCAL 1
#define ALP_EXG2_HINT_MEDIA_TYPE_BLUETOOTH 2
#define ALP_EXG2_HINT_MEDIA_TYPE_IRDA 3
#define ALP_EXG2_HINT_MEDIA_TYPE_ETH 4
#define ALP_EXG2_HINT_MEDIA_TYPE_WIFI 5
#define ALP_EXG2_HINT_MEDIA_TYPE_GPRS 6
#define ALP_EXG2_HINT_MEDIA_TYPE_EDGE 7
#define ALP_EXG2_HINT_MEDIA_TYPE_3G 8

#define ALP_EXG2_HINT_MEDIA_SPEED_INT_PARAM "exg_mediaspeed"

#define ALP_EXG2_HINT_OBJECTS_TOTAL_SIZE_INT_PARAM "exg_objtotalsize"

#define ALP_EXG2_HINT_SLOW_MEDIA_INT_PARAM "exg_slowmedia"


// -------------------------------------------------------------------------------------------------------------------------
typedef int alp_exg_handler_localonly_t;
#define ALP_EXG2_HANDLER_LOCAL_ONLY 1
#define ALP_EXG2_HANDLER_LOCAL_AND_REMOTE 0

typedef int alp_exg_handler_reentrant_t;
#define ALP_EXG2_HANDLER_IS_REENTRANT 1
#define ALP_EXG2_HANDLER_IS_NOT_REENTRANT 0

alp_status_t alp_exg2_handler_register_launch (const char *iVerb, const char *iLocalizedVerb, const char *iSubject, const char *iBundle, alp_exg_handler_localonly_t iLocalOnly, alp_exg_handler_reentrant_t iReentrant);

typedef void (*alp_exg2_handler_callback_func) (AlpExg2RequestId iRequestId);

alp_status_t alp_exg2_handler_register_callback (const char *iVerb, const char *iLocalizedVerb, const char *iSubject, alp_exg2_handler_callback_func iHandlerCallbackFunc, alp_exg_handler_localonly_t iLocalOnly, alp_exg_handler_reentrant_t iReentrant);

alp_status_t alp_exg2_handler_unregister_launch (const char *iVerb, const char *iSubject, const char *iBundle);

alp_status_t alp_exg2_handler_unregister_callback (const char *iVerb, const char *iSubject, alp_exg2_handler_callback_func iHandlerCallbackFunc);

alp_status_t alp_exg2_handler_check_registration (const char *iVerb, const char *iSubject);


// -------------------------------------------------------------------------------------------------------------------------
alp_status_t alp_exg2_handler_query_methods (const char *iAction, const char *iSubject, const char *iExcludeInvokeName, uint32_t *oEntryCount, char **oDataP);


// -------------------------------------------------------------------------------------------------------------------------
alp_status_t alp_exg2_request_create (AlpExg2Request *oRequest, const char *iVerb, const char *iSubject);

alp_status_t alp_exg2_request_delete (AlpExg2Request iRequest);

alp_status_t alp_exg2_request_set_verb (AlpExg2Request iRequest, const char *iVerb);

alp_status_t alp_exg2_request_set_subject (AlpExg2Request iRequest, const char *iSubject);


// -------------------------------------------------------------------------------------------------------------------------
alp_status_t alp_exg2_request_int_parameter_set (AlpExg2Request iRequest, const char *iParamTag, int iParamValue);

alp_status_t alp_exg2_request_string_parameter_set (AlpExg2Request iRequest, const char *iParamTag, const char *iParamValue);

alp_status_t alp_exg2_request_blob_parameter_set (AlpExg2Request iRequest, const char *iParamTag, const uint8_t *iBlob, size_t iBlobSize);


// -------------------------------------------------------------------------------------------------------------------------
alp_status_t alp_exg2_request_object_add_by_file (AlpExg2Request iRequest, const char *iObjectFile, int iDeleteWhenDone, const char *iObjectName, const char *iObjectType, const char *iObjectDscr);

alp_status_t alp_exg2_request_object_add_by_fd (AlpExg2Request iRequest, int iFd, size_t iObjectSize, const char *iObjectName, const char *iObjectType, const char *iObjectDscr);

alp_status_t alp_exg2_request_object_add_by_ptr (AlpExg2Request iRequest, uint8_t *iObjectP, size_t iObjectSize, int iFreeWhenDone, const char *iObjectName, const char *iObjectType, const char *iObjectDscr);

alp_status_t alp_exg2_request_object_add_undefined (AlpExg2Request iRequest, uint32_t *oObjectId);

alp_status_t alp_exg2_request_object_define_by_fd (AlpExg2Request iRequest, uint32_t iObjectId, int iFd, size_t iObjectSize, const char *iObjectName, const char *iObjectType, const char *iObjectDscr);

alp_status_t alp_exg2_request_object_define_by_file (AlpExg2Request iRequest, uint32_t iObjectId, const char *iObjectFile, int iDeleteWhenDone, const char *iObjectName, const char *iObjectType, const char *iObjectDscr);

alp_status_t alp_exg2_request_object_define_by_ptr (AlpExg2Request iRequest, uint32_t iObjectId, uint8_t *iObjectP, size_t iObjectSize, int iFreeWhenDone, const char *iObjectName, const char *iObjectType, const char *iObjectDscr);

alp_status_t alp_exg2_request_object_set_count_undefined (AlpExg2Request iRequest);

alp_status_t alp_exg2_request_object_set_count_final (AlpExg2Request iRequest);


// -------------------------------------------------------------------------------------------------------------------------
alp_status_t alp_exg2_request_execute_sync (AlpExg2Request iRequest);

typedef void (*alp_exg2_execute_event_info_func) (AlpExg2Request iRequest, void *iUserData, AlpExgAsyncExecuteEventInfoType *iExecuteEventInfo);

alp_status_t alp_exg2_request_execute_async (AlpExg2Request iRequest, alp_exg2_execute_event_info_func iExecuteEventInfoFunc, void *iUserData);

alp_status_t alp_exg2_request_execute_cancel (AlpExg2Request iRequest, alp_status_t iCancelErr);


// -------------------------------------------------------------------------------------------------------------------------
alp_status_t alp_exg2_request_receive_start (AlpExg2Request *oRequest, AlpExg2RequestId iRequestId);

alp_status_t alp_exg2_request_receive_complete (AlpExg2Request iRequest, alp_status_t iResult);

alp_status_t alp_exg2_request_get_verb (AlpExg2Request iRequest, char **oVerb);

alp_status_t alp_exg2_request_get_verb_const (AlpExg2Request iRequest, const char **oVerb);

alp_status_t alp_exg2_request_get_subject (AlpExg2Request iRequest, char **oSubject);

alp_status_t alp_exg2_request_get_subject_const (AlpExg2Request iRequest, const char **oSubject);


// -------------------------------------------------------------------------------------------------------------------------
alp_status_t alp_exg2_request_int_parameter_get (AlpExg2Request iRequest, const char *iParamTag, int *oParamValue);

alp_status_t alp_exg2_request_string_parameter_get (AlpExg2Request iRequest, const char *iParamTag, char **oParamValue);

alp_status_t alp_exg2_request_string_parameter_get_const (AlpExg2Request iRequest, const char *iParamTag, const char **oParamValue);

alp_status_t alp_exg2_request_blob_parameter_get (AlpExg2Request iRequest, const char *iParamTag, uint8_t **oBlob, size_t *oBlobSize);


// -------------------------------------------------------------------------------------------------------------------------
alp_status_t alp_exg2_request_receive_progress_disable (AlpExg2Request iRequest);

alp_status_t alp_exg2_request_object_rcv_count (AlpExg2Request iRequest, uint32_t *oObjectCount);

alp_status_t alp_exg2_request_object_rcv_info (AlpExg2Request iRequest, uint32_t iObjectId, size_t *oObjectSize, const char **oObjectName, const char **oObjectType, const char **oObjectDscr);

alp_status_t alp_exg2_request_object_rcv_by_file (AlpExg2Request iRequest, uint32_t iObjectId, const char *iDestFile);

alp_status_t alp_exg2_request_object_rcv_by_fd (AlpExg2Request iRequest, uint32_t iObjectId, int *oFd);

alp_status_t alp_exg2_request_object_rcv_by_ptr (AlpExg2Request iRequest, uint32_t iObjectId, uint8_t **oObjectP, size_t *oObjectSize);

alp_status_t alp_exg2_request_check_still_active (AlpExg2Request iRequest);


// -------------------------------------------------------------------------------------------------------------------------
alp_status_t alp_exg2_transport_set (AlpExg2Request iRequest, const char *iParamsValue);

alp_status_t alp_exg2_transport_get (AlpExg2Request iRequest, char **oParamsValue);

alp_status_t alp_exg2_transport_get_const (AlpExg2Request iRequest, const char **oParamsValue);


// -------------------------------------------------------------------------------------------------------------------------
alp_status_t alp_exg2_request_set_local_peer_name (AlpExg2Request iRequest, const char *iPeerName);

alp_status_t alp_exg2_request_get_remote_peer_name (AlpExg2Request iRequest, char **oPeerName);

alp_status_t alp_exg2_request_get_remote_peer_name_const (AlpExg2Request iRequest, const char **oPeerName);



#ifdef __cplusplus
 }
#endif

#endif /*ALP_EXGMGR2_H_*/

---

Generated on Wed Jul 30 07:06:39 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.