/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.apache.tomcat.jni;

Mmap
Author:Mladen Turk
Deprecated: The scope of the APR/Native Library will be reduced in Tomcat 10.1.x onwards to only those components required to provide OpenSSL integration with the NIO and NIO2 connectors.
/** Mmap * * @author Mladen Turk * * @deprecated The scope of the APR/Native Library will be reduced in Tomcat * 10.1.x onwards to only those components required to provide * OpenSSL integration with the NIO and NIO2 connectors. */
@Deprecated public class Mmap {
MMap opened for reading
/** MMap opened for reading */
public static final int APR_MMAP_READ = 1;
MMap opened for writing
/** MMap opened for writing */
public static final int APR_MMAP_WRITE = 2;
Create a new mmap'ed file out of an existing APR file.
Params:
  • file – The file turn into an mmap.
  • offset – The offset into the file to start the data pointer at.
  • size – The size of the file
  • flag – bit-wise or of:
    APR_MMAP_READ       MMap opened for reading
    APR_MMAP_WRITE      MMap opened for writing
    
  • pool – The pool to use when creating the mmap.
Throws:
  • Error – Error creating memory mapping
Returns:The newly created mmap'ed file.
/** * Create a new mmap'ed file out of an existing APR file. * @param file The file turn into an mmap. * @param offset The offset into the file to start the data pointer at. * @param size The size of the file * @param flag bit-wise or of: * <PRE> * APR_MMAP_READ MMap opened for reading * APR_MMAP_WRITE MMap opened for writing * </PRE> * @param pool The pool to use when creating the mmap. * @return The newly created mmap'ed file. * @throws Error Error creating memory mapping */
public static native long create(long file, long offset, long size, int flag, long pool) throws Error;
Duplicate the specified MMAP.
Params:
  • mmap – The mmap to duplicate.
  • pool – The pool to use for new_mmap.
Throws:
  • Error – Error duplicating memory mapping
Returns:Duplicated mmap'ed file.
/** * Duplicate the specified MMAP. * @param mmap The mmap to duplicate. * @param pool The pool to use for new_mmap. * @return Duplicated mmap'ed file. * @throws Error Error duplicating memory mapping */
public static native long dup(long mmap, long pool) throws Error;
Remove a mmap'ed.
Params:
  • mm – The mmap'ed file.
Returns:the operation status
/** * Remove a mmap'ed. * @param mm The mmap'ed file. * @return the operation status */
public static native int delete(long mm);
Move the pointer into the mmap'ed file to the specified offset.
Params:
  • mm – The mmap'ed file.
  • offset – The offset to move to.
Throws:
  • Error – Error reading file
Returns:The pointer to the offset specified.
/** * Move the pointer into the mmap'ed file to the specified offset. * @param mm The mmap'ed file. * @param offset The offset to move to. * @return The pointer to the offset specified. * @throws Error Error reading file */
public static native long offset(long mm, long offset) throws Error; }