XMPPFramework核心类介绍

  @interface XMPPStream : NSObject <GCDAsyncSocketDelegate>   

  - (void)addDelegate:(id)delegatedelegateQueue:(dispatch_queue_t)delegateQueue;   

  - (void)removeDelegate:(id)delegatedelegateQueue:(dispatch_queue_t)delegateQueue; - (void)removeDelegate:(id)delegate;   

  /** * The server's hostname that should be used to make the TCP connection. * 注释太长，简单说就是主机。这个属性是可选设置的，如果没有设置主机，默认会使用domain */ @property (readwrite, copy) NSString *hostName;   /** * The port the xmpp server is running on. * If you do not explicitly set the port, the default port will be used. * If you set the port to zero, the default port will be used. * * The default port is 5222. **/ @property (readwrite, assign) UInt16 hostPort;   

  @property (readwrite, copy) XMPPJID *myJID;   

  /** * Represents the last sent presence element concerning the presence of myJID on the server. * In other words, it represents the presence as others see us. * * This excludes presence elements sent concerning subscriptions, MUC rooms, etc. * * @see resendMyPresence **/ @property (strong, readonly) XMPPPresence *myPresence;   

  @protocol XMPPStreamDelegate @optional // 将要与服务器连接是回调 - (void)xmppStreamWillConnect:(XMPPStream *)sender;   // 当tcp socket已经与远程主机连接上时会回调此代理方法 // 若App要求在后台运行，需要设置XMPPStream's enableBackgroundingOnSocket属性 - (void)xmppStream:(XMPPStream *)sendersocketDidConnect:(GCDAsyncSocket *)socket;   // 当TCP与服务器建立连接后会回调此代理方法 - (void)xmppStreamDidStartNegotiation:(XMPPStream *)sender;   // TLS传输层协议在将要验证安全设置时会回调 // 参数settings会被传到startTLS // 此方法可以不实现的，若选择实现它，可以可以在 // 若服务端使用自签名的证书，需要在settings中添加GCDAsyncSocketManuallyEvaluateTrust=YES // - (void)xmppStream:(XMPPStream *)senderwillSecureWithSettings:(NSMutableDictionary *)settings;   // 上面的方法执行后，下一步就会执行这个代理回调 // 用于在TCP握手时手动验证是否受信任 - (void)xmppStream:(XMPPStream *)senderdidReceiveTrust:(SecTrustRef)trust                                       completionHandler:(void (^)(BOOL shouldTrustPeer))completionHandler;   // 当stream通过了SSL/TLS的安全验证时，会回调此代理方法 - (void)xmppStreamDidSecure:(XMPPStream *)sender;   // 当XML流已经完全打开时（也就是与服务器的连接完成时）会回调此代理方法。此时可以安全地与服务器通信了。 - (void)xmppStreamDidConnect:(XMPPStream *)sender;   // 注册新用户成功时的回调 - (void)xmppStreamDidRegister:(XMPPStream *)sender;   // 注册新用户失败时的回调 - (void)xmppStream:(XMPPStream *)senderdidNotRegister:(NSXMLElement *)error;   // 授权通过时的回调，也就是登录成功的回调 - (void)xmppStreamDidAuthenticate:(XMPPStream *)sender;   // 授权失败时的回调，也就是登录失败时的回调 - (void)xmppStream:(XMPPStream *)senderdidNotAuthenticate:(NSXMLElement *)error;   // 将要绑定JID resource时的回调，这是授权程序的标准部分，当验证JID用户名通过时，下一步就验证resource。若使用标准绑定处理，return nil或者不要实现此方法 - (id <XMPPCustomBinding>)xmppStreamWillBind:(XMPPStream *)sender;   // 如果服务器出现resouce冲突而导致不允许resource选择时，会回调此代理方法。返回指定的resource或者返回nil让服务器自动帮助我们来选择。一般不用实现它。 - (NSString *)xmppStream:(XMPPStream *)senderalternativeResourceForConflictingResource:(NSString *)conflictingResource;   // 将要发送IQ（消息查询）时的回调 - (XMPPIQ *)xmppStream:(XMPPStream *)senderwillReceiveIQ:(XMPPIQ *)iq; // 将要接收到消息时的回调 - (XMPPMessage *)xmppStream:(XMPPStream *)senderwillReceiveMessage:(XMPPMessage *)message; // 将要接收到用户在线状态时的回调 - (XMPPPresence *)xmppStream:(XMPPStream *)senderwillReceivePresence:(XMPPPresence *)presence;   /** * This method is called if any of the xmppStream:willReceiveX: methods filter the incoming stanza. * * It may be useful for some extensions to know that something was received, * even if it was filtered for some reason. **/ // 当xmppStream:willReceiveX:(也就是前面这三个API回调后)，过滤了stanza，会回调此代理方法。 // 通过实现此代理方法，可以知道被过滤的原因，有一定的帮助。 - (void)xmppStreamDidFilterStanza:(XMPPStream *)sender;   // 在接收了IQ（消息查询后）会回调此代理方法 - (BOOL)xmppStream:(XMPPStream *)senderdidReceiveIQ:(XMPPIQ *)iq; // 在接收了消息后会回调此代理方法 - (void)xmppStream:(XMPPStream *)senderdidReceiveMessage:(XMPPMessage *)message; // 在接收了用户在线状态消息后会回调此代理方法 - (void)xmppStream:(XMPPStream *)senderdidReceivePresence:(XMPPPresence *)presence;   // 在接收IQ/messag、presence出错时，会回调此代理方法 - (void)xmppStream:(XMPPStream *)senderdidReceiveError:(NSXMLElement *)error;   // 将要发送IQ（消息查询时）时会回调此代理方法 - (XMPPIQ *)xmppStream:(XMPPStream *)senderwillSendIQ:(XMPPIQ *)iq; // 在将要发送消息时，会回调此代理方法 - (XMPPMessage *)xmppStream:(XMPPStream *)senderwillSendMessage:(XMPPMessage *)message; // 在将要发送用户在线状态信息时，会回调此方法 - (XMPPPresence *)xmppStream:(XMPPStream *)senderwillSendPresence:(XMPPPresence *)presence;   // 在发送IQ（消息查询）成功后会回调此代理方法 - (void)xmppStream:(XMPPStream *)senderdidSendIQ:(XMPPIQ *)iq; // 在发送消息成功后，会回调此代理方法 - (void)xmppStream:(XMPPStream *)senderdidSendMessage:(XMPPMessage *)message; // 在发送用户在线状态信息成功后，会回调此方法 - (void)xmppStream:(XMPPStream *)senderdidSendPresence:(XMPPPresence *)presence;   // 在发送IQ（消息查询）失败后会回调此代理方法 - (void)xmppStream:(XMPPStream *)senderdidFailToSendIQ:(XMPPIQ *)iqerror:(NSError *)error; // 在发送消息失败后，会回调此代理方法 - (void)xmppStream:(XMPPStream *)senderdidFailToSendMessage:(XMPPMessage *)messageerror:(NSError *)error; // 在发送用户在线状态失败信息后，会回调此方法 - (void)xmppStream:(XMPPStream *)senderdidFailToSendPresence:(XMPPPresence *)presenceerror:(NSError *)error;   // 当修改了JID信息时，会回调此代理方法 - (void)xmppStreamDidChangeMyJID:(XMPPStream *)xmppStream;   // 当Stream被告知与服务器断开连接时会回调此代理方法 - (void)xmppStreamWasToldToDisconnect:(XMPPStream *)sender;   // 当发送了</stream:stream>节点时，会回调此代理方法 - (void)xmppStreamDidSendClosingStreamStanza:(XMPPStream *)sender;   // 连接超时时会回调此代理方法 - (void)xmppStreamConnectDidTimeout:(XMPPStream *)sender;   // 当与服务器断开连接后，会回调此代理方法 - (void)xmppStreamDidDisconnect:(XMPPStream *)senderwithError:(NSError *)error;   // p2p类型相关的 - (void)xmppStream:(XMPPStream *)senderdidReceiveP2PFeatures:(NSXMLElement *)streamFeatures; - (void)xmppStream:(XMPPStream *)senderwillSendP2PFeatures:(NSXMLElement *)streamFeatures;     - (void)xmppStream:(XMPPStream *)senderdidRegisterModule:(id)module; - (void)xmppStream:(XMPPStream *)senderwillUnregisterModule:(id)module;   // 当发送非XMPP元素节点时，会回调此代理方法。也就是说，如果发送的element不是 // <iq>, <message> 或者 <presence>，那么就会回调此代理方法 - (void)xmppStream:(XMPPStream *)senderdidSendCustomElement:(NSXMLElement *)element; // 当接收到非XMPP元素节点时，会回调此代理方法。也就是说，如果接收的element不是 // <iq>, <message> 或者 <presence>，那么就会回调此代理方法 - (void)xmppStream:(XMPPStream *)senderdidReceiveCustomElement:(NSXMLElement *)element;   

  @interfaceXMPPIQ: XMPPElement   // 生成iq + (XMPPIQ *)iq; + (XMPPIQ *)iqWithType:(NSString *)type; + (XMPPIQ *)iqWithType:(NSString *)typeto:(XMPPJID *)jid; + (XMPPIQ *)iqWithType:(NSString *)typeto:(XMPPJID *)jidelementID:(NSString *)eid; + (XMPPIQ *)iqWithType:(NSString *)typeto:(XMPPJID *)jidelementID:(NSString *)eidchild:(NSXMLElement *)childElement; + (XMPPIQ *)iqWithType:(NSString *)typeelementID:(NSString *)eid; + (XMPPIQ *)iqWithType:(NSString *)typeelementID:(NSString *)eidchild:(NSXMLElement *)childElement; + (XMPPIQ *)iqWithType:(NSString *)typechild:(NSXMLElement *)childElement;   - (id)init; - (id)initWithType:(NSString *)type; - (id)initWithType:(NSString *)typeto:(XMPPJID *)jid; - (id)initWithType:(NSString *)typeto:(XMPPJID *)jidelementID:(NSString *)eid; - (id)initWithType:(NSString *)typeto:(XMPPJID *)jidelementID:(NSString *)eidchild:(NSXMLElement *)childElement; - (id)initWithType:(NSString *)typeelementID:(NSString *)eid; - (id)initWithType:(NSString *)typeelementID:(NSString *)eidchild:(NSXMLElement *)childElement; - (id)initWithType:(NSString *)typechild:(NSXMLElement *)childElement;   // IQ类型，看下面的说明 - (NSString *)type;   // 判断type类型 - (BOOL)isGetIQ; - (BOOL)isSetIQ; - (BOOL)isResultIQ; - (BOOL)isErrorIQ;   // 当type为get或者set时，这个API是很有用的，用于指定是否要求有响应 - (BOOL)requiresResponse;   - (NSXMLElement *)childElement; - (NSXMLElement *)childErrorElement;   @end   

  <iqfrom="huangyibiao@welcome.com/ios"       id="xxxxxxx"      to="biaoge@welcome.com/ios"       type="get">    <queryxmlns="jabber:iq:roster"/>  </iq>    

  @interfaceXMPPPresence: XMPPElement   // Converts an NSXMLElement to an XMPPPresence element in place (no memory allocations or copying) + (XMPPPresence *)presenceFromElement:(NSXMLElement *)element;   + (XMPPPresence *)presence; + (XMPPPresence *)presenceWithType:(NSString *)type; // type：用户在线状态，看下面的讲解 // to：接收方的JID + (XMPPPresence *)presenceWithType:(NSString *)typeto:(XMPPJID *)to;   - (id)init; - (id)initWithType:(NSString *)type;   // type：用户在线状态，看下面的讲解 // to：接收方的JID - (id)initWithType:(NSString *)typeto:(XMPPJID *)to;   - (NSString *)type;   - (NSString *)show; - (NSString *)status;   - (int)priority;   - (int)intShow;   - (BOOL)isErrorPresence;   @end   

  <presencefrom="alice@wonderland.lit/pda">    <show>dnd</show>    <status>浏览器搜索：标哥的技术博客，或者直接访问www.henishuo.com</status>  </presence>    

  @interfaceXMPPMessage: XMPPElement   + (XMPPMessage *)messageFromElement:(NSXMLElement *)element;   + (XMPPMessage *)message; + (XMPPMessage *)messageWithType:(NSString *)type; + (XMPPMessage *)messageWithType:(NSString *)typeto:(XMPPJID *)to; + (XMPPMessage *)messageWithType:(NSString *)typeto:(XMPPJID *)jidelementID:(NSString *)eid; + (XMPPMessage *)messageWithType:(NSString *)typeto:(XMPPJID *)jidelementID:(NSString *)eidchild:(NSXMLElement *)childElement; + (XMPPMessage *)messageWithType:(NSString *)typeelementID:(NSString *)eid; + (XMPPMessage *)messageWithType:(NSString *)typeelementID:(NSString *)eidchild:(NSXMLElement *)childElement; + (XMPPMessage *)messageWithType:(NSString *)typechild:(NSXMLElement *)childElement;   - (id)init; - (id)initWithType:(NSString *)type; - (id)initWithType:(NSString *)typeto:(XMPPJID *)to; - (id)initWithType:(NSString *)typeto:(XMPPJID *)jidelementID:(NSString *)eid; - (id)initWithType:(NSString *)typeto:(XMPPJID *)jidelementID:(NSString *)eidchild:(NSXMLElement *)childElement; - (id)initWithType:(NSString *)typeelementID:(NSString *)eid; - (id)initWithType:(NSString *)typeelementID:(NSString *)eidchild:(NSXMLElement *)childElement; - (id)initWithType:(NSString *)typechild:(NSXMLElement *)childElement;   - (NSString *)type; - (NSString *)subject; - (NSString *)body; - (NSString *)bodyForLanguage:(NSString *)language; - (NSString *)thread;   - (void)addSubject:(NSString *)subject; - (void)addBody:(NSString *)body; - (void)addBody:(NSString *)bodywithLanguage:(NSString *)language; - (void)addThread:(NSString *)thread;   - (BOOL)isChatMessage; - (BOOL)isChatMessageWithBody; - (BOOL)isErrorMessage; - (BOOL)isMessageWithBody;   - (NSError *)errorMessage;   @end   

  <messageto="lily@jabber.org/contact" type="chat">      <body>您好？您的博客名是叫标哥的技术博客吗？地址是http://www.henishuo.com吗？</body> </message>