io.vertx.mssqlclient.MSSQLConnection Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package io.vertx.mssqlclient;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.mssqlclient.impl.MSSQLConnectionImpl;
import io.vertx.sqlclient.PreparedStatement;
import io.vertx.sqlclient.SqlConnection;
import static io.vertx.mssqlclient.MSSQLConnectOptions.fromUri;
/**
* A connection to Microsoft SQL Server.
*/
@VertxGen
public interface MSSQLConnection extends SqlConnection {
/**
* Create a connection to SQL Server with the given {@code connectOptions}.
*
* @param vertx the vertx instance
* @param connectOptions the options for the connection
* @param handler the handler called with the connection or the failure
*/
static void connect(Vertx vertx, MSSQLConnectOptions connectOptions, Handler> handler) {
Future fut = MSSQLConnectionImpl.connect(vertx, connectOptions);
if (handler != null) {
fut.onComplete(handler);
}
}
/**
* Like {@link #connect(Vertx, MSSQLConnectOptions, Handler)} but returns a {@code Future} of the asynchronous result
*/
static Future connect(Vertx vertx, MSSQLConnectOptions connectOptions) {
return MSSQLConnectionImpl.connect(vertx, connectOptions);
}
/**
* Like {@link #connect(Vertx, MSSQLConnectOptions, Handler)} with options built from {@code connectionUri}.
*/
static void connect(Vertx vertx, String connectionUri, Handler> handler) {
connect(vertx, fromUri(connectionUri), handler);
}
/**
* Like {@link #connect(Vertx, String, Handler)} but returns a {@code Future} of the asynchronous result
*/
static Future connect(Vertx vertx, String connectionUri) {
return connect(vertx, fromUri(connectionUri));
}
/**
* {@inheritDoc}
*/
@Fluent
@Override
MSSQLConnection prepare(String s, Handler> handler);
/**
* {@inheritDoc}
*/
@Fluent
@Override
MSSQLConnection exceptionHandler(Handler handler);
/**
* {@inheritDoc}
*/
@Fluent
@Override
MSSQLConnection closeHandler(Handler handler);
/**
* Set a handler called when the connection receives an informational message from the server.
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MSSQLConnection infoHandler(Handler handler);
/**
* Cast a {@link SqlConnection} to {@link MSSQLConnection}.
*
* This is mostly useful for Vert.x generated APIs like RxJava/Mutiny.
*
* @param sqlConnection the connection to cast
* @return a {@link MSSQLConnection instance}
*/
static MSSQLConnection cast(SqlConnection sqlConnection) {
return (MSSQLConnection) sqlConnection;
}
}