tel.schich.javacan.option.CanSocketOption Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javacan-core Show documentation

JavaCAN is a binding to Linux' socketcan subsystem that feels native to Java developers. The core module provides the basic socketcan bindings.

There is a newer version: 3.5.0

Show newest version

/*
 * The MIT License
 * Copyright © 2018 Phillip Schichtel
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package tel.schich.javacan.option;

import tel.schich.javacan.platform.linux.UnixFileDescriptor;

import java.io.IOException;
import java.net.SocketOption;

/**
 * This class provides the base for all socket options by this library.
 *
 * @param  the type of the option value
 */
public class CanSocketOption implements SocketOption {
    private final String name;
    private final Class type;
    private final Handler handler;

    public CanSocketOption(String name, Class type, Handler handler) {
        this.name = name;
        this.type = type;
        this.handler = handler;
    }

    @Override
    public String name() {
        return name;
    }

    @Override
    public Class type() {
        return type;
    }

    public Handler getHandler() {
        return handler;
    }

    /**
     * This interface needs to be implemented per option to call into native code to actually implement that option
     * change or extract the current value.
     *
     * @param  the type of the option value
     */
    public interface Handler {
        void set(UnixFileDescriptor handle, T val, boolean validate) throws IOException;
        T get(UnixFileDescriptor handle) throws IOException;
    }
}