Package apple.cfnetwork.struct

Class CFHostClientContext

  • public final class CFHostClientContext
extends org.moe.natj.c.StructObject

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      @Nullable CFHostClientContext.Function_copyDescription copyDescription()
      The callback used to create a descriptive string representation of the info pointer (or the data pointed to by the info pointer) for debugging purposes.
      @Nullable org.moe.natj.general.ptr.VoidPtr info()
      An arbitrary pointer to client-defined data, which can be associated with the host and is passed to the callbacks.
      @Nullable CFHostClientContext.Function_release release()
      The callback used to remove a retain previously added for the host on the info pointer.
      @Nullable CFHostClientContext.Function_retain retain()
      The callback used to add a retain for the host on the info pointer for the life of the host, and may be used for temporary references the host needs to take.
      void setCopyDescription​(@Nullable CFHostClientContext.Function_copyDescription value)
      The callback used to create a descriptive string representation of the info pointer (or the data pointed to by the info pointer) for debugging purposes.
      void setInfo​(@Nullable org.moe.natj.general.ptr.VoidPtr value)
      An arbitrary pointer to client-defined data, which can be associated with the host and is passed to the callbacks.
      void setRelease​(@Nullable CFHostClientContext.Function_release value)
      The callback used to remove a retain previously added for the host on the info pointer.
      void setRetain​(@Nullable CFHostClientContext.Function_retain value)
      The callback used to add a retain for the host on the info pointer for the life of the host, and may be used for temporary references the host needs to take.
      void setVersion​(long value)
      The version number of the structure type being passed in as a parameter to the CFHost client function.
      long version()
      The version number of the structure type being passed in as a parameter to the CFHost client function.

      • Methods inherited from class org.moe.natj.general.NativeObject

        finalize, getPeer, getPeerPointer

      • Methods inherited from class java.lang.Object

        clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CFHostClientContext

        public CFHostClientContext()

      • CFHostClientContext

        protected CFHostClientContext​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • version

        public long version()
        The version number of the structure type being passed in as a parameter to the CFHost client function. Valid version number is currently 0.

      • setVersion

        public void setVersion​(long value)
        The version number of the structure type being passed in as a parameter to the CFHost client function. Valid version number is currently 0.

      • info

        @Nullable
public @Nullable org.moe.natj.general.ptr.VoidPtr info()
        An arbitrary pointer to client-defined data, which can be associated with the host and is passed to the callbacks.

      • setInfo

        public void setInfo​(@Nullable
                    @Nullable org.moe.natj.general.ptr.VoidPtr value)
        An arbitrary pointer to client-defined data, which can be associated with the host and is passed to the callbacks.

      • retain

        @Nullable
public @Nullable CFHostClientContext.Function_retain retain()
        The callback used to add a retain for the host on the info pointer for the life of the host, and may be used for temporary references the host needs to take. This callback returns the actual info pointer to store in the host, almost always just the pointer passed as the parameter.

      • setRetain

        public void setRetain​(@Nullable
                      @Nullable CFHostClientContext.Function_retain value)
        The callback used to add a retain for the host on the info pointer for the life of the host, and may be used for temporary references the host needs to take. This callback returns the actual info pointer to store in the host, almost always just the pointer passed as the parameter.

      • setRelease

        public void setRelease​(@Nullable
                       @Nullable CFHostClientContext.Function_release value)
        The callback used to remove a retain previously added for the host on the info pointer.

      • copyDescription

        @Nullable
public @Nullable CFHostClientContext.Function_copyDescription copyDescription()
        The callback used to create a descriptive string representation of the info pointer (or the data pointed to by the info pointer) for debugging purposes. This is used by the CFCopyDescription() function.

      • setCopyDescription

        public void setCopyDescription​(@Nullable
                               @Nullable CFHostClientContext.Function_copyDescription value)
        The callback used to create a descriptive string representation of the info pointer (or the data pointed to by the info pointer) for debugging purposes. This is used by the CFCopyDescription() function.