VirtualBox

Changeset 11101

Show
Ignore:
Timestamp:
08/04/08 15:21:48 (4 months ago)
Author:
vboxsync
Message:

intnet: Documentation update (pfnXmit and pfnRecv).

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/include/VBox/intnet.h

    r11072 r11101  
    334334     * Incoming frame. 
    335335     * 
     336     * The frame may be modified when the trunk port on the switch is set to share 
     337     * the mac address of the host when hitting the wire. Currently rames containing 
     338     * ARP packets are subject to this, later other protocols like NDP/ICMPv6 may 
     339     * need editing as well when operating in this mode. 
     340     * 
    336341     * @returns true if we've handled it and it should be dropped. 
    337342     *          false if it should hit the wire. 
     
    345350     * @remarks Will grab the network semaphore. 
    346351     * 
    347      * @remark  NAT and TAP will use this interface. 
     352     * @remarks NAT and TAP will use this interface. 
     353     * 
     354     * @todo    Do any of the host require notification before frame modifications? If so, 
     355     *          we'll add a callback to INTNETTRUNKIFPORT for this (pfnSGModifying) and 
     356     *          a SG flag. 
    348357     */ 
    349358    DECLR0CALLBACKMEMBER(bool, pfnRecv,(PINTNETTRUNKSWPORT pSwitchPort, PINTNETSG pSG, uint32_t fSrc)); 
     
    529538     * @param   pIfPort     Pointer to this structure. 
    530539     * @param   pSG         Pointer to the (scatter /) gather structure for the frame. 
    531      *                      This will never be a temporary one, so, it's safe to retain 
    532      *                      it and do an asynchronous request to avoid copying. 
     540     *                      This may or may not be a temporary buffer. If it's temporary 
     541     *                      the transmit operation(s) then it's required to make a copy 
     542     *                      of the frame unless it can be transmitted synchronously. 
    533543     * @param   fDst        The destination mask. At least one bit will be set. 
    534544     * 
     
    536546     * 
    537547     * @remarks TAP and NAT will use this interface for all their traffic, see pfnIsHostMac. 
     548     * 
     549     * @todo 
    538550     */ 
    539551    DECLR0CALLBACKMEMBER(int, pfnXmit,(PINTNETTRUNKIFPORT pIfPort, PINTNETSG pSG, uint32_t fDst)); 

© 2008 Sun Microsystems, Inc.
ContactPrivacy policy