org.jinterop.dcom.common.IJIUnreferenced Maven / Gradle / Ivy
/** j-Interop (Pure Java implementation of DCOM protocol)
* Copyright (C) 2006 Vikram Roopchand
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3.0 of the License, or (at your option) any later version.
*
* Though a sincere effort has been made to deliver a professional,
* quality product,the library itself is distributed WITHOUT ANY WARRANTY;
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
*/
package org.jinterop.dcom.common;
/**
* < p>
* Implement this interface receive notifications for IJIComObjects
* when they get garbage collected. This also means that the actual interface
* reference on the COM server have a reference count of 0 and will get garbage
* collected itself by COM runtime.
*
*
* One note of caution, the IJIComObject is uniquely identified
* across the client-server relationship by it's IPID. The
* IPID should be used as a key to store a relevant "action" object
* when unReferenced method of this interface is invoked. If the
* IJIComObject is stored at a place solely for the purpose of this
* housekeeping than it will NEVER get garbage collected by the framework
* as the logic of collection is based on weak references.
*
*
*
*
* comObject.registerUnreferencedHandler(session, new IJIUnreferenced(){
* public void unReferenced()
* {
* //do something here
* }
* });
*
*
*
*
*
*
*
Please refer to MSWMI example for more details on how to use this
* class.
*
* @since 1.21
*/
public interface IJIUnreferenced {
/**
* Called when the IJIComObject associated with this interface
* is garbage collected by the framework.
*
*/
public void unReferenced();
}