Skip to content

Commit d90a52b

Browse files
committed
rename get/set_errorhandler to errhandler
fixes #500
1 parent 82bff4a commit d90a52b

File tree

4 files changed

+28
-24
lines changed

4 files changed

+28
-24
lines changed

docs/src/advanced.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ MPI.infoval
3737

3838
```@docs
3939
MPI.ErrorHandler
40-
MPI.get_errorhandler
41-
MPI.set_errorhandler!
40+
MPI.get_errhandler
41+
MPI.set_errhandler!
4242
```
4343

src/deprecated.jl

+4
Original file line numberDiff line numberDiff line change
@@ -206,3 +206,7 @@ import Base: @deprecate
206206

207207
@deprecate(Accumulate(origin, rank, disp, op, win), Accumulate!(origin, rank, disp, op, win), false)
208208
@deprecate(Get_accumulate(origin, result, rank, disp, op, win), Get_accumulate!(origin, result, rank, disp, op, win), false)
209+
210+
211+
@deprecate(get_errorhandler(obj), get_errhandler(obj), false)
212+
@deprecate(set_errorhandler!(obj, errhandler), set_errhandler!(obj, errhandler), false)

src/errorhandler.jl

+19-19
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
MPI.Errhandler
2+
MPI.ErrorHandler
33
44
An MPI error handler object. Currently only two are supported:
55
@@ -19,57 +19,57 @@ function free(errh::ErrorHandler)
1919
return nothing
2020
end
2121

22-
function set_default_error_handler_return()
23-
set_errorhandler!(COMM_SELF, ERRORS_RETURN)
24-
set_errorhandler!(COMM_WORLD, ERRORS_RETURN)
22+
function set_default_errhandler_return()
23+
set_errhandler!(COMM_SELF, ERRORS_RETURN)
24+
set_errhandler!(COMM_WORLD, ERRORS_RETURN)
2525
end
2626

2727
"""
28-
MPI.get_errorhandler(comm::MPI.Comm)
29-
MPI.get_errorhandler(win::MPI.Win)
30-
MPI.get_errorhandler(file::MPI.File.FileHandle)
28+
MPI.get_errhandler(comm::MPI.Comm)
29+
MPI.get_errhandler(win::MPI.Win)
30+
MPI.get_errhandler(file::MPI.File.FileHandle)
3131
3232
Get the current [`ErrorHandler`](@ref) for the relevant MPI object.
3333
3434
# See also
35-
- [`set_errorhandler!`](@ref)
35+
- [`set_errhandler!`](@ref)
3636
"""
37-
function get_errorhandler(comm::Comm)
37+
function get_errhandler(comm::Comm)
3838
errh = ErrorHandler(ERRORS_ARE_FATAL.val)
3939
@mpichk ccall((:MPI_Comm_get_errhandler, libmpi), Cint, (MPI_Comm, Ptr{MPI_Errhandler}), comm, errh)
4040
finalizer(free, errh)
4141
return errh
4242
end
43-
function get_errorhandler(win::Win)
44-
errh = ErrorHandler(ERRORS_ARE_FATAL.val)
43+
function get_errhandler(win::Win)
44+
errh = v(ERRORS_ARE_FATAL.val)
4545
@mpichk ccall((:MPI_Win_get_errhandler, libmpi), Cint, (MPI_Win, Ptr{MPI_Errhandler}), win, errh)
4646
return errh
4747
end
48-
function get_errorhandler(file::File.FileHandle)
48+
function get_errhandler(file::File.FileHandle)
4949
errh = ErrorHandler(ERRORS_ARE_FATAL.val)
5050
@mpichk ccall((:MPI_File_get_errhandler, libmpi), Cint, (MPI_File, Ptr{MPI_Errhandler}), file, errh)
5151
return errh
5252
end
5353

5454
"""
55-
MPI.set_errorhandler!(comm::MPI.Comm, errh::ErrorHandler)
56-
MPI.set_errorhandler!(win::MPI.Win, errh::ErrorHandler)
57-
MPI.set_errorhandler!(file::MPI.File.FileHandle, errh::ErrorHandler)
55+
MPI.set_errhandler!(comm::MPI.Comm, errh::Errhandler)
56+
MPI.set_errhandler!(win::MPI.Win, errh::Errhandler)
57+
MPI.set_errhandler!(file::MPI.File.FileHandle, errh::Errhandler)
5858
5959
Set the [`ErrorHandler`](@ref) for the relevant MPI object.
6060
6161
# See also
62-
- [`get_errorhandler`](@ref)
62+
- [`get_errhandler`](@ref)
6363
"""
64-
function set_errorhandler!(comm::Comm, errh::ErrorHandler)
64+
function set_errhandler!(comm::Comm, errh::ErrorHandler)
6565
@mpichk ccall((:MPI_Comm_set_errhandler, libmpi), Cint, (MPI_Comm, MPI_Errhandler), comm, errh)
6666
return nothing
6767
end
68-
function set_errorhandler!(win::Win, errh::ErrorHandler)
68+
function set_errhandler!(win::Win, errh::ErrorHandler)
6969
@mpichk ccall((:MPI_Win_set_errhandler, libmpi), Cint, (MPI_Win, MPI_Errhandler), win, errh)
7070
return nothing
7171
end
72-
function set_errorhandler!(file::File.FileHandle, errh::ErrorHandler)
72+
function set_errhandler!(file::File.FileHandle, errh::ErrorHandler)
7373
@mpichk ccall((:MPI_File_set_errhandler, libmpi), Cint, (MPI_File, MPI_Errhandler), file, errh)
7474
return nothing
7575
end

test/test_errorhandler.jl

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ using MPI, Test
22
MPI.Init()
33

44
@test MPI.ERRORS_ARE_FATAL != MPI.ERRORS_RETURN
5-
@test MPI.get_errorhandler(MPI.COMM_SELF) == MPI.ERRORS_RETURN
5+
@test MPI.get_errhandler(MPI.COMM_SELF) == MPI.ERRORS_RETURN
66
@test_throws MPI.MPIError MPI.Send(rand(10), 2, 0, MPI.COMM_SELF)
77

8-
MPI.set_errorhandler!(MPI.COMM_SELF, MPI.ERRORS_ARE_FATAL)
9-
@test MPI.get_errorhandler(MPI.COMM_SELF) == MPI.ERRORS_ARE_FATAL
8+
MPI.set_errhandler!(MPI.COMM_SELF, MPI.ERRORS_ARE_FATAL)
9+
@test MPI.get_errhandler(MPI.COMM_SELF) == MPI.ERRORS_ARE_FATAL
1010

0 commit comments

Comments
 (0)