zapIStunMessage.idl

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/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 the Mozilla SIP client project.
 *
 * The Initial Developer of the Original Code is 8x8 Inc.
 * Portions created by the Initial Developer are Copyright (C) 2005
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Alex Fritze <alex@croczilla.com> (original author)
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or 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 either the GPL or 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 GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

[scriptable, uuid(a86483da-1baf-4417-a644-562e0c3ae87a)]
interface zapIStunMessage : nsISupports
{
  ACString serialize();

  void deserialize(in ACString packet,
                   [array, size_is(count)] out
                   unsigned short unknownAttribs,
                   out unsigned long count);
  
  const unsigned short BINDING_REQUEST_MESSAGE              = 0x0001;
  const unsigned short BINDING_RESPONSE_MESSAGE             = 0x0101;
  const unsigned short BINDING_ERROR_RESPONSE_MESSAGE       = 0x0111;
  const unsigned short SHARED_SECRET_REQUEST_MESSAGE        = 0x0002;
  const unsigned short SHARED_SECRET_RESPONSE_MESSAGE       = 0x0102;
  const unsigned short SHARED_SECRET_ERROR_RESPONSE_MESSAGE = 0x0112;
  attribute unsigned short messageType;

  attribute ACString transactionID;

  void initTransactionID();
  
  attribute boolean hasMappedAddressAttrib;
  attribute unsigned short mappedAddressPort;
  attribute ACString mappedAddress;
  attribute boolean hasResponseAddressAttrib;
  attribute unsigned short responseAddressPort;
  attribute ACString responseAddress;
  attribute boolean hasChangeRequestAttrib;
  attribute boolean changeRequestChangeIP;
  attribute boolean changeRequestChangePort;
  attribute boolean hasSourceAddressAttrib;
  attribute unsigned short sourceAddressPort;
  attribute ACString sourceAddress;
  attribute boolean hasChangedAddressAttrib;
  attribute unsigned short changedAddressPort;
  attribute ACString changedAddress;
  attribute boolean hasUsernameAttrib;
  attribute ACString username;
  attribute boolean hasPasswordAttrib;
  attribute ACString password;
  attribute boolean hasMessageIntegrityAttrib;
  attribute ACString messageIntegrity;
  void generateMessageIntegrityAttrib(in ACString key);
  boolean checkMessageIntegrity(in ACString key);
  attribute boolean hasErrorCodeAttrib;
  attribute ACString errorCode;
  attribute ACString errorCodeReasonPhrase;
  attribute boolean hasUnknownAttributesAttrib;
  void getUnknownAttributes(out unsigned long count,
                            [array, size_is(count), retval] out
                            unsigned short attribs);
  void setUnknownAttributes([array, size_is(count)] in unsigned short attribs,
                            in unsigned long count);
  attribute boolean hasReflectedFromAttrib;
  attribute unsigned short reflectedFromPort;
  attribute ACString reflectedFrom;
  attribute boolean hasXORMappedAddressAttrib;
  attribute unsigned short XORMappedAddressPort;
  attribute ACString XORMappedAddress;
  attribute boolean hasXOROnlyAttrib;
  attribute boolean hasServerAttrib;
  attribute ACString server;
};

%{ C++

// {90557418-0EDE-4C40-8FB8-13D009882646}
#define ZAP_STUNMESSAGE_CID \
    { 0x90557418, 0x0ede, 0x4c40, { 0x8f, 0xb8, 0x13, 0xd0, 0x09, 0x88, 0x26, 0x46 } }
    
#define ZAP_STUNMESSAGE_CONTRACTID "@mozilla.org/zap/stun-message;1"
%}

---