io.r2dbc.postgresql.message.frontend.FunctionCall Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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 io.r2dbc.postgresql.message.frontend;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.ByteBufAllocator;
import io.r2dbc.postgresql.message.Format;
import io.r2dbc.postgresql.util.Assert;
import org.reactivestreams.Publisher;
import reactor.core.publisher.Mono;

import java.util.List;
import java.util.Objects;

import static io.r2dbc.postgresql.message.frontend.FrontendMessageUtils.writeByte;
import static io.r2dbc.postgresql.message.frontend.FrontendMessageUtils.writeBytes;
import static io.r2dbc.postgresql.message.frontend.FrontendMessageUtils.writeInt;
import static io.r2dbc.postgresql.message.frontend.FrontendMessageUtils.writeLengthPlaceholder;
import static io.r2dbc.postgresql.message.frontend.FrontendMessageUtils.writeShort;
import static io.r2dbc.postgresql.message.frontend.FrontendMessageUtils.writeSize;

/**
 * The FunctionCall message.
 */
public final class FunctionCall implements FrontendMessage {

    private static final int NULL = -1;

    private final List argumentFormats;

    private final List arguments;

    private final int functionId;

    private final Format resultFormat;

    /**
     * Creates a new message.
     *
     * @param argumentFormats the argument formats
     * @param arguments       the value of the arguments, in the format indicated by the associated format
     * @param functionId      the object ID of the function to call
     * @param resultFormat    the format code for the function result
     * @throws IllegalArgumentException if {@code argumentFormats}, {@code arguments}, or {@code resultFormat} is {@code null}
     */
    public FunctionCall(List argumentFormats, List arguments, int functionId, Format resultFormat) {
        this.argumentFormats = Assert.requireNonNull(argumentFormats, "argumentFormats must not be null");
        this.arguments = Assert.requireNonNull(arguments, "arguments must not be null");
        this.functionId = functionId;
        this.resultFormat = Assert.requireNonNull(resultFormat, "resultFormat must not be null");
    }

    @Override
    public Publisher encode(ByteBufAllocator byteBufAllocator) {
        Assert.requireNonNull(byteBufAllocator, "byteBufAllocator must not be null");

        return Mono.fromSupplier(() -> {
            ByteBuf out = byteBufAllocator.ioBuffer();

            writeByte(out, 'F');
            writeLengthPlaceholder(out);
            writeInt(out, this.functionId);

            writeShort(out, this.argumentFormats.size());
            this.argumentFormats.forEach(format -> writeShort(out, format.getDiscriminator()));

            writeShort(out, this.arguments.size());
            this.arguments.forEach(argument -> {
                if (argument == null) {
                    writeInt(out, NULL);
                } else {
                    writeInt(out, argument.readableBytes());
                    writeBytes(out, argument);
                }
            });

            writeShort(out, this.resultFormat.getDiscriminator());

            return writeSize(out);
        });
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        FunctionCall that = (FunctionCall) o;
        return this.functionId == that.functionId &&
            Objects.equals(this.argumentFormats, that.argumentFormats) &&
            Objects.equals(this.arguments, that.arguments) &&
            this.resultFormat == that.resultFormat;
    }

    @Override
    public int hashCode() {
        return Objects.hash(this.argumentFormats, this.arguments, this.functionId, this.resultFormat);
    }

    @Override
    public String toString() {
        return "FunctionCall{" +
            "argumentFormats=" + this.argumentFormats +
            ", arguments=" + this.arguments +
            ", functionId=" + this.functionId +
            ", resultFormat=" + this.resultFormat +
            '}';
    }

}