BasicOutPacket (Java QQ Library Javadoc)

Overview

Package

Class

Tree

Deprecated

Index

Help

JML

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.jqql.packets
Class BasicOutPacket

java.lang.Object
  net.sf.jqql.packets.Packet
      net.sf.jqql.packets.OutPacket
          net.sf.jqql.packets.BasicOutPacket

Direct Known Subclasses:: AddFriendAuthResponsePacket, AddFriendExPacket, AddFriendPacket, AdvancedSearchUserPacket, AuthorizePacket, BasicDebugPacket, ChangeStatusPacket, ClusterCommandPacket, DeleteFriendPacket, DownloadGroupFriendPacket, FriendDataOpPacket, FriendLevelOpPacket, GetFriendListPacket, GetOnlineOpPacket, GetUserInfoPacket, GroupDataOpPacket, KeepAlivePacket, LoginPacket, LogoutPacket, ModifyInfoPacket, PrivacyDataOpPacket, ReceiveIMReplyPacket, RemoveSelfPacket, RequestKeyPacket, RequestLoginTokenPacket, SearchUserPacket, SendIMPacket, SendSMSPacket, SignatureOpPacket, TempSessionOpPacket, UnknownOutPacket, UploadGroupFriendPacket, UserPropertyOpPacket, WeatherOpPacket

public abstract class BasicOutPacket
extends OutPacket
extends OutPacket

 output packet base class of basic protocol family
 packet of basic protocol family have format like:
 1. packet header sign, 1 byte, 0x02
 2. client version code, 2 byte
 3. command, 2 byte
 4. packet sequence number, 2 byte
 5. user QQ number, 4 byte
 6. packet body
 7. packet tail sign, 1 byte, 0x03

 Note: 6 part will use session key encrypt.log in packet exception, 6 part will use Cipher Key encrypt. 
 request log in token packet exception, 6 part not need encrypt.

 åŸºæœ¬åè®®æ—çš„è¾“å‡ºåŒ…åŸºç±»
 åŸºæœ¬åè®®æ—çš„åŒ…éƒ½å…·æœ‰ä»¥ä¸‹çš„æ ¼å¼:
 1. åŒ…å¤´æ ‡å¿—ï¼Œ1å—èŠ‚ï¼Œ0x02
 2. å®¢æˆ·ç«¯ç‰ˆæœ¬ä»£ç ï¼Œ2å—èŠ‚
 3. å‘½ä»¤ï¼Œ2å—èŠ‚
 4. åŒ…åºå·, 2å—èŠ‚
 5. ç”¨æˆ·QQå·ï¼Œ4å—èŠ‚
 6. åŒ…ä½“
 7. åŒ…å°¾æ ‡å¿—ï¼Œ1å—èŠ‚ï¼Œ0x03
 Note: 6éƒ¨åˆ†å°†ç”¨ä¼šè¯å¯†é’¥åŠ å¯†, ç™»å½•åŒ…ä¾‹å¤–ï¼Œ6éƒ¨åˆ†è¦ç”¨å¯†ç å¯†é’¥åŠ å¯†ã€‚è¯·æ±‚ç™»å½•ä»¤ç‰ŒåŒ…ä¾‹å¤–ï¼Œ6éƒ¨åˆ†ä¸éœ€åŠ å¯†

Author:: notxx, luma

Field Summary

Fields inherited from class net.sf.jqql.packets.OutPacket
`ack, key, resendCountDown, sendCount, seq, timeout`

Fields inherited from class net.sf.jqql.packets.Packet
`bodyBuf, bodyDecrypted, command, crypter, ds, duplicated, header, log, sequence, source, user`

Constructor Summary
`protected`	`BasicOutPacket(ByteBuffer buf, int length, QQUser user)`
`protected`	`BasicOutPacket(ByteBuffer buf, QQUser user)`
`protected`	`BasicOutPacket(char command, boolean ack, QQUser user)` create a Specify Parameters packet.

Method Summary
`protected byte[]`	`decryptBody(byte[] body, int offset, int length)` decrypt packet body è§£å¯†åŒ…ä½“
`protected byte[]`	`encryptBody(byte[] b, int offset, int length)` encrypt packet body åŠ å¯†åŒ…ä½“
`protected byte[]`	`getBodyBytes(ByteBuffer buf, int length)` get byte array of packet body å¾—åˆ°åŒ…ä½“çš„å—èŠ‚æ•°ç»„
`protected int`	`getCryptographStart()`
`int`	`getFamily()`
`protected int`	`getHeadLength()`
`protected int`	`getLength(int bodyLength)` get total length of UDP form packet, rule out TCP form å¾—åˆ°UDPå½¢å¼åŒ…çš„æ€»é•¿åº¦ï¼Œä¸è€ƒè™‘TCPå½¢å¼
`String`	`getPacketName()`
`protected int`	`getTailLength()`
`protected void`	`parseHeader(ByteBuffer buf)` parse packet header from current position of buf ä»Žbufçš„å½“å‰ä½ç½®è§£æžåŒ…å¤´
`protected void`	`parseTail(ByteBuffer buf)` parse packet tail from current position of buf ä»Žbufçš„å½“å‰æœªçŸ¥è§£æžåŒ…å°¾
`protected void`	`postFill(ByteBuffer buf, int startPos)` backfill, some field must fill whole packet to make sure its content, for example length field, then this method will be used after tail filling.
`protected void`	`putHead(ByteBuffer buf)` change packet header to byte stream, and write into appointed ByteBuffer object.
`protected void`	`putTail(ByteBuffer buf)` change packet tail to byte stream, and write into appointed ByteBuffer object.
`String`	`toString()`
`protected boolean`	`validateHeader()` checkout header æ ¡éªŒå¤´éƒ¨

Methods inherited from class net.sf.jqql.packets.OutPacket
`dump, fill, getKey, getNextSeq, getSendCount, getTimeout, needAck, needResend, parseBody, setKey, setSendCount, setTimeout`

Methods inherited from class net.sf.jqql.packets.Packet
`equals, getCommand, getHeader, getSequence, getSource, hash, hashCode, isDuplicated, putBody, setDuplicated, setHeader, setSequence`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

BasicOutPacket

protected BasicOutPacket(char command,
                         boolean ack,
                         QQUser user)

create a Specify Parameters packet. æž„é€ ä¸€ä¸ªå‚æ•°æŒ‡å®šçš„åŒ….

Parameters:: command - command å‘½ä»¤.; ack - whether need answer æ˜¯å¦éœ€è¦å›žåº”.

BasicOutPacket

protected BasicOutPacket(ByteBuffer buf,
                         QQUser user)
                  throws PacketParseException

Throws:: PacketParseException

BasicOutPacket

protected BasicOutPacket(ByteBuffer buf,
                         int length,
                         QQUser user)
                  throws PacketParseException

Throws:: PacketParseException

Method Detail

validateHeader

protected boolean validateHeader()

Description copied from class: Packet

checkout header æ ¡éªŒå¤´éƒ¨

Specified by:: validateHeader in class Packet

Returns:: true means header usable trueè¡¨ç¤ºå¤´éƒ¨æœ‰æ•ˆ

getBodyBytes

protected byte[] getBodyBytes(ByteBuffer buf,
                              int length)

Description copied from class: Packet

get byte array of packet body å¾—åˆ°åŒ…ä½“çš„å—èŠ‚æ•°ç»„

Specified by:: getBodyBytes in class Packet

Parameters:: buf - ByteBuffer; length - packet total length åŒ…æ€»é•¿åº¦
Returns:: byte array of packet body åŒ…ä½“å—èŠ‚æ•°ç»„

getLength

protected int getLength(int bodyLength)

Description copied from class: Packet

get total length of UDP form packet, rule out TCP form å¾—åˆ°UDPå½¢å¼åŒ…çš„æ€»é•¿åº¦ï¼Œä¸è€ƒè™‘TCPå½¢å¼

Specified by:: getLength in class Packet

Parameters:: bodyLength - packet body length åŒ…ä½“é•¿åº¦
Returns:: packet length åŒ…é•¿åº¦

parseTail

protected void parseTail(ByteBuffer buf)
                  throws PacketParseException

Description copied from class: Packet

parse packet tail from current position of buf ä»Žbufçš„å½“å‰æœªçŸ¥è§£æžåŒ…å°¾

Specified by:: parseTail in class Packet

Parameters:: buf - ByteBuffer
Throws:: PacketParseException - if parse error å¦‚æžœè§£æžå‡ºé”™

getPacketName

public String getPacketName()

Overrides:: getPacketName in class OutPacket

Returns:: descriptive name of packet åŒ…çš„æè¿°æ€§åç§°

decryptBody

protected byte[] decryptBody(byte[] body,
                             int offset,
                             int length)

Description copied from class: Packet

decrypt packet body è§£å¯†åŒ…ä½“

Specified by:: decryptBody in class Packet

Parameters:: body - byte array of packet body åŒ…ä½“å—èŠ‚æ•°ç»„; offset - offset of packet body begin åŒ…ä½“å¼€å§‹åç§»; length - packet length åŒ…ä½“é•¿åº¦
Returns:: è§£å¯†çš„åŒ…ä½“å—èŠ‚æ•°ç»„ // byte array of decrypted packet body

encryptBody

protected byte[] encryptBody(byte[] b,
                             int offset,
                             int length)

Description copied from class: Packet

encrypt packet body åŠ å¯†åŒ…ä½“

Specified by:: encryptBody in class Packet

Parameters:: b - unencrypt byte array æœªåŠ å¯†çš„å—èŠ‚æ•°ç»„; offset - offset of packet body begin åŒ…ä½“å¼€å§‹çš„åç§»; length - packet body length åŒ…ä½“é•¿åº¦
Returns:: encrypted packet body åŠ å¯†çš„åŒ…ä½“

putHead

protected void putHead(ByteBuffer buf)

Description copied from class: Packet

change packet header to byte stream, and write into appointed ByteBuffer object. å°†åŒ…å¤´éƒ¨è½¬åŒ–ä¸ºå—èŠ‚æµ, å†™å…¥æŒ‡å®šçš„ByteBufferå¯¹è±¡.

Specified by:: putHead in class Packet

Parameters:: buf - ByteBuffer object whicn packet need to write into å†™å…¥çš„ByteBufferå¯¹è±¡.

postFill

protected void postFill(ByteBuffer buf,
                        int startPos)

Description copied from class: OutPacket

backfill, some field must fill whole packet to make sure its content, for example length field, then this method will be used after tail filling. å›žå¡«ï¼Œæœ‰äº›å—æ®µå¿…é¡»å¡«å®Œæ•´ä¸ªåŒ…æ‰èƒ½ç¡®å®šå…¶å†…å®¹ï¼Œæ¯”å¦‚é•¿åº¦å—æ®µï¼Œé‚£ä¹ˆè¿™ä¸ªæ–¹æ³•å°†åœ¨ å°¾éƒ¨å¡«å……ä¹‹åŽè°ƒç”¨

Specified by:: postFill in class OutPacket

Parameters:: buf - ByteBuffer; startPos - packet initial position åŒ…èµ·å§‹ä½ç½®

putTail

protected void putTail(ByteBuffer buf)

Description copied from class: Packet

change packet tail to byte stream, and write into appointed ByteBuffer object. å°†åŒ…å°¾éƒ¨è½¬åŒ–ä¸ºå—èŠ‚æµ, å†™å…¥æŒ‡å®šçš„ByteBufferå¯¹è±¡.

Specified by:: putTail in class Packet

Parameters:: buf - ByteBuffer object whicn packet need to write into å†™å…¥çš„ByteBufferå¯¹è±¡.

parseHeader

protected void parseHeader(ByteBuffer buf)
                    throws PacketParseException

Description copied from class: Packet

parse packet header from current position of buf ä»Žbufçš„å½“å‰ä½ç½®è§£æžåŒ…å¤´

Specified by:: parseHeader in class Packet

Parameters:: buf - ByteBuffer
Throws:: PacketParseException - if parse error å¦‚æžœè§£æžå‡ºé”™

getHeadLength

protected int getHeadLength()

Specified by:: getHeadLength in class Packet

Returns:: packet header length åŒ…å¤´é•¿åº¦

getTailLength

protected int getTailLength()

Specified by:: getTailLength in class Packet

Returns:: packet tail length åŒ…å°¾é•¿åº¦

toString

public String toString()

Overrides:: toString in class Object

getCryptographStart

protected int getCryptographStart()

Specified by:: getCryptographStart in class Packet

Returns:: start position of cryptograph, relative to the first byte of packet body. if this packet is unknown packet, return -1, this method only available to some protocol family. å¯†æ–‡çš„èµ·å§‹ä½ç½®ï¼Œè¿™ä¸ªä½ç½®æ˜¯ç›¸å¯¹äºŽåŒ…ä½“çš„ç¬¬ä¸€ä¸ªå—èŠ‚æ¥è¯´çš„ï¼Œå¦‚æžœè¿™ä¸ªåŒ…æ˜¯æœªçŸ¥åŒ…ï¼Œ è¿”å›ž-1ï¼Œè¿™ä¸ªæ–¹æ³•åªå¯¹æŸäº›åè®®æ—æœ‰æ„ä¹‰

getFamily

public int getFamily()

Specified by:: getFamily in class Packet

Returns:: sign this packet belong which protocol family æ ‡è¯†è¿™ä¸ªåŒ…å±žäºŽå“ªä¸ªåè®®æ—

Overview

Package

Class

Tree

Deprecated

Index

Help

JML

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.jqql.packets Class BasicOutPacket

BasicOutPacket

BasicOutPacket

BasicOutPacket

validateHeader

getBodyBytes

getLength

parseTail

getPacketName

decryptBody

encryptBody

putHead

postFill

putTail

parseHeader

getHeadLength

getTailLength

toString

getCryptographStart

getFamily

net.sf.jqql.packets
Class BasicOutPacket