internetradio2.0/datastructuresinc/irchannelserverurl.h
changeset 14 896e9dbc5f19
parent 12 608f67c22514
child 15 065198191975
equal deleted inserted replaced
12:608f67c22514 14:896e9dbc5f19
     1 /*
       
     2 * Copyright (c) 2006-2007 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 "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:  ?Description
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef IRCHANNELSERVERURL_H
       
    20 #define IRCHANNELSERVERURL_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 class RReadStream;
       
    25 class RWriteStream;
       
    26 
       
    27 /**
       
    28  * This class provides the basic structure to hold the preset's url data
       
    29  *information that come from the isds server.
       
    30  *It also provides the basic getter and setter functions to 
       
    31  *manage the preset's url information.
       
    32  *for url selection for a particular bitrate some functionality 
       
    33  *has been provided
       
    34  *copy constructor and assignment operator has been provided to 
       
    35  *override the default ones 
       
    36  *
       
    37  * @code
       
    38  *CIRChannelServerUrl* presetUrl = CIRChannelServerUrl::NewL()
       
    39  *preset->SetXXX();
       
    40  *preset->GetXXX();
       
    41  * @endcode
       
    42  *   
       
    43  */
       
    44  
       
    45 class CIRChannelServerUrl:public CBase
       
    46 	{
       
    47 public:
       
    48 	
       
    49 	/**
       
    50 	*CIRChannelServerUrl::NewL()
       
    51 	*Static function
       
    52 	*standard two phased constructor
       
    53 	*@return *CIRChannelServerUrl
       
    54 	*/
       
    55 	IMPORT_C	static CIRChannelServerUrl* NewL();
       
    56 	
       
    57 	/**
       
    58 	*CIRChannelServerUrl::NewLC()
       
    59 	*Static function
       
    60 	*standard two phased constructor
       
    61 	*@return *CIRChannelServerUrl
       
    62 	*/
       
    63 	IMPORT_C	static CIRChannelServerUrl* NewLC();
       
    64 	
       
    65 	/**
       
    66 	*CIRChannelServerUrl::SetServerName()
       
    67 	*sets server name 
       
    68 	*@param TDesC
       
    69 	*/
       
    70 	IMPORT_C	void SetServerName(const TDesC& aServerName);
       
    71 	
       
    72 	/**
       
    73 	*CIRChannelServerUrl::SetServerUrl()
       
    74 	*sets server url 
       
    75 	*@param TDesC
       
    76 	*/
       
    77 	IMPORT_C	void SetServerUrl(const TDesC& aServerUrl);
       
    78 	
       
    79 	/**
       
    80 	*CIRChannelServerUrl::SetBitRate()
       
    81 	*sets server bitrate 
       
    82 	*@param TInt
       
    83 	*/
       
    84 	IMPORT_C	void SetBitRate(TInt aBitrate);
       
    85 	
       
    86 	/**
       
    87 	*CIRChannelServerUrl::GetServerName()
       
    88 	*gets server name 
       
    89 	*@return TDesC
       
    90 	*/
       
    91 	IMPORT_C	const TDesC& GetServerName() const;
       
    92 	
       
    93 	/**
       
    94 	*CIRChannelServerUrl::GetServerUrl()
       
    95 	*gets server url 
       
    96 	*@return TDesC
       
    97 	*/
       
    98 	IMPORT_C	const TDesC& GetServerUrl() const;
       
    99 	
       
   100 	/**
       
   101 	*CIRChannelServerUrl::GetBitRate()
       
   102 	*gets server bitrate
       
   103 	*@return TInt
       
   104 	*/
       
   105 	IMPORT_C	TInt GetBitRate() const;
       
   106 	
       
   107 	/**
       
   108 	*CIRChannelServerUrl::~CIRChannelServerUrl()
       
   109 	*standard C++ destructor 
       
   110 	*/	
       
   111 	~CIRChannelServerUrl();
       
   112 	
       
   113 	/**
       
   114 	*CIRChannelServerUrl::=()
       
   115 	*standard C++ copy constructor(deep copy) 
       
   116 	*@param CIRChannelServerUrl
       
   117 	*/	
       
   118 	IMPORT_C	CIRChannelServerUrl& operator=(const CIRChannelServerUrl& churl);
       
   119 		
       
   120 	/**
       
   121 	*CIRChannelServerUrl::ExternalizeL()
       
   122 	*function to externalize url data
       
   123 	*@param CIRChannelServerUrl
       
   124 	*/
       
   125 	IMPORT_C void ExternalizeL(RWriteStream& aWriteStream);	
       
   126 	
       
   127 	/**
       
   128 	*CIRChannelServerUrl::InternalizeL()
       
   129 	*function to internalize url data
       
   130 	*@param CIRChannelServerUrl
       
   131 	*/
       
   132 	IMPORT_C void InternalizeL(RReadStream& aReadStream);
       
   133 
       
   134 protected:
       
   135 	
       
   136 	/**
       
   137 	*CIRChannelServerUrl::ConstructL()
       
   138 	*standard second phase construction
       
   139 	*/	
       
   140 	void ConstructL() const;
       
   141 	
       
   142 public:
       
   143 	//server name
       
   144 	HBufC *iServerName;
       
   145 	HBufC *iURL;
       
   146 	//bit rate
       
   147 	TInt iBitrate;
       
   148 	};
       
   149 	
       
   150 #endif //IRCHANNELSERVERURL_H