loudmouth/tsrc/inc/tstlm.h
changeset 10 59927b2d3b75
parent 0 d0f3a028347a
equal deleted inserted replaced
0:d0f3a028347a 10:59927b2d3b75
     1 /*
       
     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of the License "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:   tstlm.h
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef TSTLM_H
       
    22 #define TSTLM_H
       
    23 
       
    24 //  INCLUDES
       
    25 #include <StifLogger.h>
       
    26 #include <TestScripterInternal.h>
       
    27 #include <StifTestModule.h>
       
    28 
       
    29 
       
    30 // CONSTANTS
       
    31 //const ?type ?constant_var = ?constant;
       
    32 
       
    33 // MACROS
       
    34 //#define ?macro ?macro_def
       
    35 // Logging path
       
    36 _LIT( KtstlmLogPath, "\\logs\\testframework\\tstlm\\" ); 
       
    37 // Log file
       
    38 _LIT( KtstlmLogFile, "tstlm.txt" ); 
       
    39 
       
    40 // FUNCTION PROTOTYPES
       
    41 //?type ?function_name(?arg_list);
       
    42 
       
    43 // FORWARD DECLARATIONS
       
    44 //class ?FORWARD_CLASSNAME;
       
    45 class Ctstlm;
       
    46 
       
    47 // DATA TYPES
       
    48 //enum ?declaration
       
    49 //typedef ?declaration
       
    50 //extern ?data_type;
       
    51 
       
    52 // CLASS DECLARATION
       
    53 
       
    54 /**
       
    55 *  Ctstlm test class for STIF Test Framework TestScripter.
       
    56 *  ?other_description_lines
       
    57 *
       
    58 *  @lib ?library
       
    59 *  @since ?Series60_version
       
    60 */
       
    61 NONSHARABLE_CLASS(Ctstlm) : public CScriptBase
       
    62     {
       
    63     public:  // Constructors and destructor
       
    64 
       
    65         /**
       
    66         * Two-phased constructor.
       
    67         */
       
    68         static Ctstlm* NewL( CTestModuleIf& aTestModuleIf );
       
    69 
       
    70         /**
       
    71         * Destructor.
       
    72         */
       
    73         virtual ~Ctstlm();
       
    74 
       
    75     public: // New functions
       
    76 
       
    77         /**
       
    78         * ?member_description.
       
    79         * @since ?Series60_version
       
    80         * @param ?arg1 ?description
       
    81         * @return ?description
       
    82         */
       
    83         //?type ?member_function( ?type ?arg1 );
       
    84 
       
    85     public: // Functions from base classes
       
    86 
       
    87         /**
       
    88         * From CScriptBase Runs a script line.
       
    89         * @since ?Series60_version
       
    90         * @param aItem Script line containing method name and parameters
       
    91         * @return Symbian OS error code
       
    92         */
       
    93         virtual TInt RunMethodL( CStifItemParser& aItem );
       
    94 
       
    95     protected:  // New functions
       
    96 
       
    97         /**
       
    98         * ?member_description.
       
    99         * @since ?Series60_version
       
   100         * @param ?arg1 ?description
       
   101         * @return ?description
       
   102         */
       
   103         //?type ?member_function( ?type ?arg1 );
       
   104 
       
   105     protected:  // Functions from base classes
       
   106 
       
   107         /**
       
   108         * From ?base_class ?member_description
       
   109         */
       
   110         //?type ?member_function();
       
   111 
       
   112     private:
       
   113 
       
   114         /**
       
   115         * C++ default constructor.
       
   116         */
       
   117         Ctstlm( CTestModuleIf& aTestModuleIf );
       
   118 
       
   119         /**
       
   120         * By default Symbian 2nd phase constructor is private.
       
   121         */
       
   122         void ConstructL();
       
   123 
       
   124         // Prohibit copy constructor if not deriving from CBase.
       
   125         // ?classname( const ?classname& );
       
   126         // Prohibit assigment operator if not deriving from CBase.
       
   127         // ?classname& operator=( const ?classname& );
       
   128 
       
   129         /**
       
   130         * Frees all resources allocated from test methods.
       
   131         * @since ?Series60_version
       
   132         */
       
   133         void Delete();
       
   134 
       
   135         /**
       
   136         * Test methods are listed below. 
       
   137         */
       
   138 
       
   139         /**
       
   140         * Example test method.
       
   141         * @since ?Series60_version
       
   142         * @param aItem Script line containing parameters.
       
   143         * @return Symbian OS error code.
       
   144         */        
       
   145         
       
   146         // LmConnection
       
   147         virtual TInt lm_connection_newL( CStifItemParser& aItem );
       
   148         virtual TInt lm_new_with_contextL( CStifItemParser& aItem );
       
   149         virtual TInt lm_connection_openL( CStifItemParser& aItem );
       
   150         virtual TInt lm_connection_closeL ( CStifItemParser& aItem );
       
   151         virtual TInt lm_authenticateL ( CStifItemParser& aItem );
       
   152         virtual TInt lm_connection_is_openL ( CStifItemParser& aItem );
       
   153         virtual TInt lm_is_authenticatedL ( CStifItemParser& aItem );
       
   154         virtual TInt lm_connection_set_get_serverL ( CStifItemParser& aItem );        
       
   155         virtual TInt lm_connection_set_get_jidL ( CStifItemParser& aItem );
       
   156         virtual TInt lm_connection_set_get_portL ( CStifItemParser& aItem );
       
   157         virtual TInt lm_connection_set_get_sslL ( CStifItemParser& aItem );
       
   158         virtual TInt lm_connection_set_get_proxyL ( CStifItemParser& aItem );
       
   159         
       
   160         virtual TInt lm_connection_sendL(CStifItemParser& aItem );
       
   161         virtual TInt lm_connection_send400charL(CStifItemParser& aItem );
       
   162         virtual TInt lm_connection_send_repeatedL(CStifItemParser& aItem );
       
   163         
       
   164         
       
   165         virtual TInt lm_send_with_replyL ( CStifItemParser& aItem );
       
   166         virtual TInt register_message_handlerL ( CStifItemParser& aItem );
       
   167         virtual TInt set_disconnect_functionL ( CStifItemParser& aItem );
       
   168         virtual TInt lm_connection_send_rawL ( CStifItemParser& aItem );
       
   169         virtual TInt lm_connection_get_stateL ( CStifItemParser& aItem );
       
   170         virtual TInt lm_connection_refL ( CStifItemParser& aItem );
       
   171         virtual TInt lm_connection_unrefL ( CStifItemParser& aItem );
       
   172         
       
   173         virtual TInt lm_connection_is_open_WhenConnectionIsClosedL ( CStifItemParser& aItem );
       
   174         virtual TInt lm_is_authenticated_WhenNotAuthenticatedL ( CStifItemParser& aItem );
       
   175         virtual TInt lm_connection_set_server_WithNULL ( CStifItemParser& aItem );
       
   176         virtual TInt lm_connection_set_jid_WithNULL ( CStifItemParser& aItem );
       
   177         virtual TInt lm_connection_set_port_WithNULL ( CStifItemParser& aItem );
       
   178         virtual TInt lm_connection_set_ssl_WithNULL ( CStifItemParser& aItem );
       
   179         virtual TInt lm_connection_closeWhenNotOpenedL ( CStifItemParser& aItem );
       
   180         // LmMessage
       
   181         virtual TInt lm_message_newL ( CStifItemParser& aItem );
       
   182         virtual TInt lm_message_new_with_sub_typeL ( CStifItemParser& aItem );
       
   183         virtual TInt lm_message_get_typeL ( CStifItemParser& aItem );
       
   184         virtual TInt lm_message_get_sub_typeL ( CStifItemParser& aItem );
       
   185         virtual TInt lm_message_get_nodeL ( CStifItemParser& aItem );
       
   186         virtual TInt lm_message_refL ( CStifItemParser& aItem );
       
   187         virtual TInt lm_message_unrefL ( CStifItemParser& aItem );
       
   188         
       
   189         // LmMessageHanlder
       
   190         virtual TInt lm_message_handler_newL ( CStifItemParser& aItem );
       
   191         virtual TInt lm_message_handler_invalidateL ( CStifItemParser& aItem );
       
   192         virtual TInt lm_message_handler_is_validL ( CStifItemParser& aItem );
       
   193         virtual TInt lm_message_handler_refL ( CStifItemParser& aItem );
       
   194         virtual TInt lm_message_handler_unrefL ( CStifItemParser& aItem );
       
   195         
       
   196         // LmMessageNode
       
   197         
       
   198         virtual TInt lm_message_node_set_get_valueL ( CStifItemParser& aItem ); 
       
   199         virtual TInt lm_message_node_add_childL ( CStifItemParser& aItem ); 
       
   200         virtual TInt lm_message_node_get_childL ( CStifItemParser& aItem ); 
       
   201         virtual TInt lm_message_node_find_childL ( CStifItemParser& aItem );         
       
   202         virtual TInt lm_message_node_set_get_attributesL ( CStifItemParser& aItem );
       
   203              
       
   204         
       
   205         virtual TInt lm_message_node_set_get_raw_modeL ( CStifItemParser& aItem );        
       
   206         virtual TInt lm_message_node_refL ( CStifItemParser& aItem );
       
   207         virtual TInt lm_message_node_unrefL ( CStifItemParser& aItem );        
       
   208         virtual TInt lm_message_node_to_stringL ( CStifItemParser& aItem );
       
   209         
       
   210         // LmSSL
       
   211         virtual TInt lm_ssl_newL( CStifItemParser& aItem );
       
   212         virtual TInt lm_ssl_is_supportedL( CStifItemParser& aItem );
       
   213         virtual TInt lm_ssl_get_fingerprintL( CStifItemParser& aItem );        
       
   214         virtual TInt lm_ssl_refL( CStifItemParser& aItem );
       
   215         virtual TInt lm_ssl_unrefL( CStifItemParser& aItem );
       
   216         
       
   217         // LmProxy
       
   218         virtual TInt lm_proxy_newL( CStifItemParser& aItem );
       
   219         virtual TInt lm_proxy_new_with_serverL( CStifItemParser& aItem );        
       
   220         virtual TInt lm_proxy_set_get_typeL( CStifItemParser& aItem );        
       
   221         virtual TInt lm_proxy_set_get_serverL( CStifItemParser& aItem );        
       
   222         virtual TInt lm_proxy_set_get_portL( CStifItemParser& aItem );        
       
   223         virtual TInt lm_proxy_set_get_usernameL( CStifItemParser& aItem );        
       
   224         virtual TInt lm_proxy_set_get_passwordL( CStifItemParser& aItem );        
       
   225         virtual TInt lm_proxy_refL( CStifItemParser& aItem );
       
   226         virtual TInt lm_proxy_unrefL( CStifItemParser& aItem );
       
   227         
       
   228         // lm-send-sync example        
       
   229         virtual TInt lm_send_syncL ( CStifItemParser& aItem );
       
   230         
       
   231         //fetching contact list
       
   232         
       
   233         virtual TInt lm_fetching_contactlist_L( CStifItemParser& aItem );
       
   234         
       
   235         virtual TInt lm_fetching_presenceL( CStifItemParser& aItem );
       
   236         
       
   237         // subscribe presence for contact
       
   238         
       
   239         virtual TInt lm_subscribe_contact_L( CStifItemParser& aItem );
       
   240         
       
   241         
       
   242         virtual TInt lm_authenticate_WithUnexistingJID( CStifItemParser& aItem );
       
   243         virtual TInt lm_authenticate_WithBadPasswordL( CStifItemParser& aItem );
       
   244         virtual TInt lm_authenticate_WhenConnectionIsNotOpenedL( CStifItemParser& aItem );
       
   245         virtual TInt lm_connection_open_with_badserverL(CStifItemParser& aItem); 
       
   246         
       
   247         virtual TInt lm_connection_send_receiveL(CStifItemParser& aItem);
       
   248         virtual TInt lm_login_testL(CStifItemParser& aItem);
       
   249         
       
   250         virtual TInt lm_add_contactL(CStifItemParser& aItem);
       
   251         virtual TInt lm_remove_contactL(CStifItemParser& aItem);
       
   252         virtual TInt lm_connection_cancel_openL(CStifItemParser& aItem);
       
   253         virtual TInt lm_connection_get_privacy_listsL(CStifItemParser& aItem);
       
   254         virtual TInt lm_connection_set_privacy_listsL(CStifItemParser& aItem);
       
   255         virtual TInt lm_connection_send_image_bytestream_msgL(CStifItemParser& aItem);
       
   256         virtual TInt lm_connection_send_image_bytestream_iqL(CStifItemParser& aItem);
       
   257         virtual TInt lm_connection_send_multiple_connL(CStifItemParser& aItem);
       
   258         virtual TInt lm_connection_block_contactL(CStifItemParser& aItem);
       
   259         virtual TInt lm_connection_unblock_contactL(CStifItemParser& aItem);
       
   260         virtual TInt lm_connection_set_active_listL(CStifItemParser& aItem);
       
   261         virtual TInt lm_connection_set_unexist_active_listL(CStifItemParser& aItem);
       
   262         virtual TInt lm_connection_set_decline_active_listL(CStifItemParser& aItem);
       
   263         virtual TInt lm_connection_get_one_privacy_listL(CStifItemParser& aItem);
       
   264         virtual TInt lm_connection_set_one_privacy_listL(CStifItemParser& aItem);
       
   265         virtual TInt lm_connection_get_many_privacy_list_from_listnameL(CStifItemParser& aItem);
       
   266         virtual TInt lm_connection_set_one_unexist_privacy_listL(CStifItemParser& aItem);
       
   267         virtual TInt lm_connection_get_one_unexist_privacy_listL(CStifItemParser& aItem);
       
   268         virtual TInt lm_connection_create_one_privacy_listL(CStifItemParser& aItem);
       
   269         virtual TInt lm_service_discoveryL(CStifItemParser& aItem);
       
   270         virtual TInt lm_service_discovery_connected_resourceL(CStifItemParser& aItem);
       
   271         virtual TInt lm_simple_communications_blockingL(CStifItemParser& aItem);
       
   272         virtual TInt lm_send_im_with_replyL(CStifItemParser& aItem);
       
   273         virtual TInt lm_receive_any_messageL(CStifItemParser& aItem);
       
   274         virtual TInt lm_login_multiple_sessionsL(CStifItemParser& aItem);
       
   275         virtual TInt lm_change_own_presenceL(CStifItemParser& aItem);
       
   276         virtual TInt  lm_login_test_invalid_serverL(CStifItemParser& aItem);
       
   277         virtual TInt  lm_login_test_invalid_portL(CStifItemParser& aItem);
       
   278         
       
   279         virtual TInt lm_memory_leak_testL(CStifItemParser& aItem);
       
   280         virtual TInt lm_nft_updating_presenceL(CStifItemParser& aItem);
       
   281         virtual TInt lm_nft_presence_notificationL(CStifItemParser& aItem);
       
   282         virtual TInt lm_nft_send_text_messageL(CStifItemParser& aItem);
       
   283         virtual TInt lm_nft_open_conversation_with_multipleL(CStifItemParser& aItem);
       
   284         virtual TInt lm_nft_fetch300_contactL(CStifItemParser& aItem);
       
   285         virtual TInt lm_nft_loginlogoutmultipletime(CStifItemParser& aItem);
       
   286         virtual TInt lm_nft_receiving100_message_L(CStifItemParser& aItem);
       
   287     public:     // Data
       
   288         // ?one_line_short_description_of_data
       
   289         //?data_declaration;
       
   290 
       
   291     protected:  // Data
       
   292         // ?one_line_short_description_of_data
       
   293         //?data_declaration;
       
   294 
       
   295     private:    // Data
       
   296         
       
   297         // ?one_line_short_description_of_data
       
   298         //?data_declaration;
       
   299 
       
   300         // Reserved pointer for future extension
       
   301         //TAny* iReserved;
       
   302 
       
   303     public:     // Friend classes
       
   304         //?friend_class_declaration;
       
   305     protected:  // Friend classes
       
   306         //?friend_class_declaration;
       
   307     private:    // Friend classes
       
   308         //?friend_class_declaration;
       
   309 
       
   310     };
       
   311 
       
   312 #endif      // TSTLM_H
       
   313 
       
   314 // End of File